en/AipService.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 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 |
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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-AipServiceRoleBasedAdministrator</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Grants administrative rights to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceRoleBasedAdministrator cmdlet grants administrative rights to the protection service from Azure Information Protection, so that administrators you delegate to configure this service can do so by using PowerShell commands. </maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service; you cannot do this configuration by using a management portal.</maml:para> <maml:para>When you run this cmdlet, you can specify a user or a group in Azure AD, and you can run the cmdlet multiple times to add new users and new groups. To see the full list, use Get-AipServiceRoleBasedAdministrator.</maml:para> <maml:para>If you specify a group, it can be any group in Azure AD and does not need to be mail-enabled. To specify a group that is not mail-enabled, use either the SecurityGroupDisplayName parameter, or the ObjectId parameter. You can also use these parameters or the EmailAddress parameter for a mail-enabled group.</maml:para> <maml:para>For more information about the user and group requirements, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare). This information includes how to identify the different group types and how to find the values to specify them when you run this cmdlet. </maml:para> <maml:para>After delegating control to other administrators, they might find it useful to reference a list of the cmdlets they can run, grouped by administrative task. For this information, see Administering the protection service by using PowerShell (https://docs.microsoft.com/information-protection/deploy-use/administer-powershell).</maml:para> <maml:para>Note that these administrative roles are separate from the Azure Active Directory admin roles or Office 365 admin roles.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to have administrative rights for the protection service. If the user has no email address, specify the user's Universal Principal 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group to have administrative rights for the protection 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to have administrative rights for the protection service. If the user has no email address, specify the user's Universal Principal 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to have administrative rights for the protection service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role of either Azure Information Protection service global administrator (the user can configure all aspects of the protection service by using PowerShell commands) or Azure Information Protection service connector administrator (the account is granted least privileges to configure and run the Rights Management (RMS) connector).</maml:para> <maml:para>To specify these roles, use the following values: - GlobalAdministrator</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>The default value is GlobalAdministrator.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group to have administrative rights for the protection 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Grant administrative rights by using a display name</maml:title> <dev:code>PS C:\>Add-AipServiceRoleBasedAdministrator -SecurityGroupDisplayName "Finance Employees"</dev:code> <dev:remarks> <maml:para>This command grants administrative rights to the protection service for the group that has a display name of "Finance Employees".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 2: Grant administrative rights by using a GUID ----</maml:title> <dev:code>PS C:\>Add-AipServiceRoleBasedAdministrator -ObjectId 2c8afe23-bf58-4289-bea1-05131aeb50ab</dev:code> <dev:remarks> <maml:para>This command grants administrative rights to the protection service for the group that has the specified GUID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044795</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Add-AipServiceSuperUser</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Adds a super user to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceSuperUser cmdlet adds an individual account to the super user list for your organization. This operation makes the account an owner for all content that is protected by your organization. This means that these super users can decrypt this rights-protected content and remove rights-protection from it, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams.</maml:para> <maml:para>However, before a super user can do these operations, the super user feature for Azure Information Protection must be enabled by using the Enable-AipServiceSuperUserFeature cmdlet. By default, the super user feature is not enabled.</maml:para> <maml:para>Specify the account by email address or service principal ID. To specify a user who does not have an email address, specify their User Principal Name instead. For more information, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare). </maml:para> <maml:para>To specify a group rather than individual users, use the Set-AipServiceSuperUserGroup cmdlet instead of this Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user in your organization to grant this user super user privileges.</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:syntaxItem> <command:syntaxItem> <maml:name>Add-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:Description> <maml:para>Specifies the AppPrincipalId of the service principal in your organization to grant this account super user privileges. Use the Get-MsolServicePrincipal cmdlet to get an existing service principal, or the New-MsolServicePrincipalCredential (https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0)cmdlet to create a new service principal.</maml:para> <maml:para>The service principal ID is converted to a pseudo-email address and added to the super user list for the organization. For example, `Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"` adds 3C367900-44D1-4865-9379-9A3227042C25@<AIPService tenant ID>.aipservice.na.aadrm.com to the super user list.</maml:para> <maml:para>You can remove the service principal from the super user list by using the Remove-AipServiceSuperUser cmdlet and this pseudo-email address. You can use the Get-AipServiceSuperUser cmdlet to verify the email address.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user in your organization to grant this user super user privileges.</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="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:Description> <maml:para>Specifies the AppPrincipalId of the service principal in your organization to grant this account super user privileges. Use the Get-MsolServicePrincipal cmdlet to get an existing service principal, or the New-MsolServicePrincipalCredential (https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0)cmdlet to create a new service principal.</maml:para> <maml:para>The service principal ID is converted to a pseudo-email address and added to the super user list for the organization. For example, `Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"` adds 3C367900-44D1-4865-9379-9A3227042C25@<AIPService tenant ID>.aipservice.na.aadrm.com to the super user list.</maml:para> <maml:para>You can remove the service principal from the super user list by using the Remove-AipServiceSuperUser cmdlet and this pseudo-email address. You can use the Get-AipServiceSuperUser cmdlet to verify the email address.</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:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Add a user as a super user ------------</maml:title> <dev:code>PS C:\>Add-AipServiceSuperUser -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command adds an individual user to your organization's super user list for Azure Information Protection, by specifying the user's email address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Add a service principal as a super user ------</maml:title> <dev:code>PS C:\>Add-AipServiceSuperUser -ServicePrincipalId "3C367900-44D1-4865-9379-9A3227042C25"</dev:code> <dev:remarks> <maml:para>This command adds a service principal to your organization's super user list for Azure Information Protection, by specifying the service principal's AppPrincipalId.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044912</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-MsolServicePrincipalCredential</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/msonline/new-msolserviceprincipalcredential?view=azureadps-1.0</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Add-AipServiceTemplate</command:name> <command:verb>Add</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Creates a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AipServiceTemplate cmdlet creates a protection template for Azure Information Protection with the specified name, description, and policy, and sets the status of the template to archived or published.</maml:para> <maml:para>The same configuration actions can also be done in the Azure portal. </maml:para> <maml:para>Important: Before you use this cmdlet, you must first create a rights definition object that specifies the rights that you want to grant and to whom, by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>You can store a maximum of 500 custom templates (published or archived) in Azure. If you can't add new templates because you have reached this limit as a result of keeping many archived templates, consider exporting them to save the information locally and then removing these templates in Azure.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template. </maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AfterDays</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>Note: This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box if you configured APPLICATION COMPATIBILITY in the Azure classic portal. The classic portal is now retired and there is no equivalent setting in the Azure portal.</maml:para> <maml:para>The Azure Information Protection client supports departmental templates whereas Outlook on the web and Exchange ActiveSync are examples of applications that do not currently support departmental templates. For these Exchange applications (and all other applications that cannot support departmental templates), you must decide whether all users can select a departmental template from the list of available templates, or no users can select a departmental template from the list.</maml:para> <maml:para>This setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to select the template itself.</maml:para> <maml:para>If you have applications that do not yet natively support departmental templates, you can use a template download scriptor other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template.</maml:para> <maml:para>The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1. To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair.The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> <maml:para>Rights definition objects contain the email address for the identity and the rights to assign to it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template.</maml:para> <maml:para>Allowed values are Archived and Published .</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not visible to users. </maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Archived</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentFormats</maml:name> <maml:Description> <maml:para>Specifies a list of content formats that are supported by this template.</maml:para> <maml:para>The content format describes the type of object that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template. </maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>Note: This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box if you configured APPLICATION COMPATIBILITY in the Azure classic portal. The classic portal is now retired and there is no equivalent setting in the Azure portal.</maml:para> <maml:para>The Azure Information Protection client supports departmental templates whereas Outlook on the web and Exchange ActiveSync are examples of applications that do not currently support departmental templates. For these Exchange applications (and all other applications that cannot support departmental templates), you must decide whether all users can select a departmental template from the list of available templates, or no users can select a departmental template from the list.</maml:para> <maml:para>This setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to select the template itself.</maml:para> <maml:para>If you have applications that do not yet natively support departmental templates, you can use a template download scriptor other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template.</maml:para> <maml:para>The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1. To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair.The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> <maml:para>Rights definition objects contain the email address for the identity and the rights to assign to it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template.</maml:para> <maml:para>Allowed values are Archived and Published .</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not visible to users. </maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[],System.String[],System.String[],System.string,System.DateTime,System.int,System.int</maml:name> </dev:type> <maml:description> <maml:para>-Names $Names ; One or more names for the template, in various languages to present to users depending on their system locale.</maml:para> <maml:para>[-Descriptions $Descriptions] ; One or more descriptions for the template, in various languages to present to users depending on their system locale.</maml:para> <maml:para>[-RightsDefinitions {$r1,$r2,...}] ; A list of rights definitions in the form of Rights Definition objects.</maml:para> <maml:para>[-ContentExpirationOption ContentExpirationType.Never|OnDate|AfterDays] ; The type of content expiration for content protected with the template.</maml:para> <maml:para>[-ContentExpirationDate DateTime ] ; The date or time when the content expires, if ContentExpirationOption is set to OnDate.</maml:para> <maml:para>[-ContentValidityDuration int] ; The number of days for which content is available after it is protected if ContentExpirationOption is set to AfterDays.</maml:para> <maml:para>[-LicenseValidityDuration int] ; The number of days for which content is available online until it expires (0-9999). To specify unlimited access, use -1. To specify that a license must be obtained for each use and that content is available only online, use 0.</maml:para> <maml:para>[-Status TemplateStatus.Archived|Published] ; The status of the template. Archived templates are available to consume previously protected content but are not presented to users. Published templates are distributed to users and made available for protecting content.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other. If a locale ID is specified, its value must contain a non-empty string.</maml:para> <maml:para></maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organización"</maml:para> <maml:para>The rights are specified as a list of rights definition objects that contain the email address for the identity and the rights to assign to it.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a departmental template for confidential content</maml:title> <dev:code>PS C:\> $names = @{} PS C:\> $names[1033] = "New Launch - Confidential content" PS C:\> $names[1034] = " Nuevo Lanzamiento - Contenido confidencial" PS C:\> $descriptions = @{} PS C:\> $descriptions[1033] = "This content is confidential for people working on the New Launch project and should not be shared externally" PS C:\> $descriptions[1034] = "Este contenido es confidencial para empleados trabajando en el proyecto Nuevo Lanzamiento y no debe ser compartido fuera de la organización" PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT" PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW","DOCEDIT" PS C:\> Add-AipServiceTemplate -Names $names -Descriptions $Descriptions -LicenseValidityDuration 5 -RightsDefinitions $r1, $r2 -ScopedIdentities engineering@contoso.com -Status Published</dev:code> <dev:remarks> <maml:para>This example creates a departmental template for engineers when they are working on the New Launch project. The template is named New Launch - Confidential Content and has names and descriptions in English and in Spanish. It grants View and Export rights to the marketing department (lets them view and save to a non-protected file) by using the marketing@contoso.com group, and View and DocEdit rights (lets them view and edit the contents but not save the changes) to the engineering department by using the engineering@contoso.com group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044916</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AipServiceRightsDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Clear-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Clear</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Clears the group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-AipServiceDoNotTrackUserGroup cmdlet removes the currently configured group for the users who must not be tracked by the Azure Information Protection document tracking feature. This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>This cmdlet does not delete the specified group from Azure Active Directory. Instead, a group will no longer be used to exempt users from tracking. As a result, all users in your organization will now be tracked when you use the document tracking feature. </maml:para> <maml:para>You must use PowerShell to remove this group from the Azure Information Protection service; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-AipServiceDoNotTrackUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Clear-AipServiceDoNotTrackUserGroup</dev:code> <dev:remarks> <maml:para>This command removes the currently configured group (if set) that exempts users from being tracked by the document tracking feature. As a result, all users in your organization can be tracked when you use the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045007</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Clear-AipServiceSuperUserGroup</command:name> <command:verb>Clear</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Removes the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-AipServiceSuperUserGroup cmdlet removes the super user group for Azure Information Protection.</maml:para> <maml:para>This cmdlet does not affect users that are individually assigned the super user privilege with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-AipServiceSuperUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Remove the super user group ------------</maml:title> <dev:code>PS C:\>Clear-AipServiceSuperUserGroup</dev:code> <dev:remarks> <maml:para>This command removes the super user group, if one exists, for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045013</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Connect-AipService</command:name> <command:verb>Connect</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Connects to Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-AipService cmdlet connects you to Azure Information Protection so that you can then run administrative commands for the protection service for your tenant. This cmdlet can also be used by a partner company that manages your tenant.</maml:para> <maml:para>You must run this cmdlet before you can run the other cmdlets in this module.</maml:para> <maml:para>To connect to Azure Information Protection, use an account that is one of the following: - A global admin for your Office 365 tenant.</maml:para> <maml:para>- A global administrator for your Azure AD tenant. However, this account cannot be a Microsoft account (MSA) or from another Azure tenant.</maml:para> <maml:para>- A user account from your tenant that has been granted administrative rights to Azure Information Protection by using the Add-AipServiceRoleBasedAdministrator cmdlet.</maml:para> <maml:para></maml:para> <maml:para>Tip: If you are not prompted for your credentials, and you see an error message such as Cannot use this feature without credentials , verify that Internet Explorer is configured to use Windows integrated authentication. If this setting is not enabled, enable it, restart Internet Explorer, and then retry authentication to the Information Protection service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:Description> <maml:para>Use this parameter to connect to Azure Information Protection by using a token that you acquire from Azure Active Directory, using the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. This connection method lets you sign in to Azure Information Protection non-interactively.</maml:para> <maml:para>To get the access token, make sure that the account that you use from your tenant is not using multi-factor authentication (MFA). See Example 3 for how you might do this.</maml:para> <maml:para>You cannot use this parameter with the Credential 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential (https://go.microsoft.com/fwlink/?LinkID=293936)cmdlet. For more information, type `Get-Help Get-Cmdlet`.</maml:para> <maml:para>The cmdlet prompts you for a password.</maml:para> <maml:para>You cannot use this parameter with the AccessToken parameter and do not use it if your account is configured to use multi-factor authentication (MFA).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AipService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure instance for sovereign clouds. Valid values are:</maml:para> <maml:para>- AzureCloud: Commercial offering of Azure</maml:para> <maml:para>- AzureChinaCloud: Azure Operated by 21Vianet</maml:para> <maml:para>- AzureUSGovernment: Azure Government</maml:para> <maml:para>- AzureUSGovernment2: Azure Government 2</maml:para> <maml:para>- AzureUSGovernment3: Azure Government 3</maml:para> <maml:para></maml:para> <maml:para>For more information about using Azure Information Protection with Azure Government, see Azure Information Protection Premium Government Service Description (https://docs.microsoft.com/enterprise-mobility-security/solutions/ems-aip-premium-govt-service-description).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureCloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureChinaCloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureUSGovernment3</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureRmEnvironment</command:parameterValue> <dev:type> <maml:name>AzureRmEnvironment</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:Description> <maml:para>Use this parameter to connect to Azure Information Protection by using a token that you acquire from Azure Active Directory, using the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. This connection method lets you sign in to Azure Information Protection non-interactively.</maml:para> <maml:para>To get the access token, make sure that the account that you use from your tenant is not using multi-factor authentication (MFA). See Example 3 for how you might do this.</maml:para> <maml:para>You cannot use this parameter with the Credential 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object. To obtain a PSCredential object, use the Get-Credential (https://go.microsoft.com/fwlink/?LinkID=293936)cmdlet. For more information, type `Get-Help Get-Cmdlet`.</maml:para> <maml:para>The cmdlet prompts you for a password.</maml:para> <maml:para>You cannot use this parameter with the AccessToken parameter and do not use it if your account is configured to use multi-factor authentication (MFA).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnvironmentName</maml:name> <maml:Description> <maml:para>Specifies the Azure instance for sovereign clouds. Valid values are:</maml:para> <maml:para>- AzureCloud: Commercial offering of Azure</maml:para> <maml:para>- AzureChinaCloud: Azure Operated by 21Vianet</maml:para> <maml:para>- AzureUSGovernment: Azure Government</maml:para> <maml:para>- AzureUSGovernment2: Azure Government 2</maml:para> <maml:para>- AzureUSGovernment3: Azure Government 3</maml:para> <maml:para></maml:para> <maml:para>For more information about using Azure Information Protection with Azure Government, see Azure Information Protection Premium Government Service Description (https://docs.microsoft.com/enterprise-mobility-security/solutions/ems-aip-premium-govt-service-description).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRmEnvironment</command:parameterValue> <dev:type> <maml:name>AzureRmEnvironment</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:Description> <maml:para>Specifies the tenant GUID. The cmdlet connects to Azure Information Protection for the tenant that you specify by GUID.</maml:para> <maml:para>If you do not specify this parameter, the cmdlet connects to the tenant that your account belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Connect to Azure Information Protection and be prompted for your user name and other credentials</maml:title> <dev:code>PS C:\> Connect-AipService</dev:code> <dev:remarks> <maml:para>This command connects to the protection service from Azure Information Protection. This is the simplest way to connect to the service, by running the cmdlet with no parameters.</maml:para> <maml:para>You are prompted for your user name and password. If your account is configured to use multi-factor authentication, you are then prompted for your alternative method of authentication, and then connected to the service.</maml:para> <maml:para>If your account is configured to use multi-factor authentication, you must use this method to connect to Azure Information Protection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Connect to Azure Information Protection with stored credentials</maml:title> <dev:code>PS C:\>$AdminCredentials = Get-Credential "Admin@aadrm.contoso.com" PS C:\> Connect-AipService -Credential $AdminCredentials</dev:code> <dev:remarks> <maml:para>The first command creates a PSCredential object and stores your specified user name and password in the $AdminCredentials variable. When you run this command, you are prompted for the password for the user name that you specified.</maml:para> <maml:para>The second command connects to Azure Information Protection by using the credentials stored in $AdminCredentials . If you disconnect from the service and reconnect while the variable is still in use, simply rerun the second command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Connect to Azure Information Protection with a token</maml:title> <dev:code>PS C:\>[Reflection.Assembly]::LoadFile("C:\Windows\system32\WindowsPowerShell\v1.0\Modules\AADRM\Microsoft.IdentityModel.Clients.ActiveDirectory.dll") PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224'; PS C:\> $resourceId = 'https://api.aadrm.com/'; PS C:\> $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224'; PS C:\> $userName='admin@contoso.com'; <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides an example of password.")]--> PS C:\> $password='Passw0rd!'; PS C:\> $redirectUri = new-object System.Uri("https://aadrm.com/AADRMAdminPowershell"); PS C:\> $authority = "https://login.microsoftonline.com/common"; PS C:\> $authContext = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext($authority); PS C:\> $userCreds = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential($userName, $password); PS C:\> $authenticationResult = $authContext.AcquireToken($resourceId,$clientId,$userCreds); PS C:\> Import-module aadrm PS C:\> Connect-AipServiceservice -AccessToken $authenticationResult.AccessToken</dev:code> <dev:remarks> <maml:para>This example shows how you could connect to Azure Information Protection by using the AccessToken parameter, which lets you authenticate without a prompt. This connection method requires you to specify the client ID '90f610bf-206d-4950-b61d-37fa6fd1b224' and the resource ID 'https://api.aadrm.com/'. After the connection is open, you can then run the administrative commands from this module that you need.</maml:para> <maml:para>After you confirm that these commands result in successfully connecting to Azure Information Protection, you could run them non-interactively, for example, from a script.</maml:para> <maml:para>Note that for illustration purposes, this example uses the user name of "admin@contoso.com" with the password of "Passw0rd!". In a production environment when you use this connection method non-interactively, use additional methods to secure the password so that it is not stored in clear text. For example, use the ConvertTo-SecureString command or use Key Vault to store the password as a secret.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045019</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Credential</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293936</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Convert-AipServiceKeyToKeyVault</command:name> <command:verb>Convert</command:verb> <command:noun>AipServiceKeyToKeyVault</command:noun> <maml:description> <maml:para>Changes the location of a legacy customer-managed key in Azure Information Protection with the location of a customer-managed key in Azure Key Vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Convert-AipServiceKeyToKeyVault cmdlet is only for customers who have previously created a customer-managed key for Azure Rights Management and have received an invitation from Microsoft to migrate their Azure Information Protection tenant key to Azure Key Vault.</maml:para> <maml:para>Important: Do not run this cmdlet if you have not received this invitation from Microsoft and do not run this cmdlet without assistance from Microsoft.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>Azure Information Protection now uses Azure Key Vault to manage and monitor a customer-managed tenant key. To create a customer-managed tenant key for the first time, run Use-AipServiceKeyVaultKey instead of this cmdlet.</maml:para> <maml:para>For more information about how to manage your Azure Information Protection tenant key, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>Before you run this cmdlet, you will need to identify your original customer-managed tenant key. To do that, use the Get-AipServiceKeys cmdlet. From the output and identified key, you will need the KeyIdentifier value for the KeyIdentifier parameter when you run this cmdlet.</maml:para> <maml:para>Also, your organization's administrator for Azure Key Vault must create a new key for Azure Information Protection and supply you with a URL for this key. You will need to specify the URL for the KeyVaultKeyUrl parameter when you run this cmdlet. This Azure Key Vault administrator must also grant the Azure Rights Management service from Azure Information Protection access to the key vault that contains the key.</maml:para> <maml:para>For security reasons, this cmdlet does not let you change the access control for the key; this must be done from Key Vault.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-AipServiceKeyToKeyVault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier value of the original customer-managed tenant key that you now want to manage from Azure Key Vault.</maml:para> <maml:para>To get the key identifier value, use the Get-AipServiceKeys 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier value of the original customer-managed tenant key that you now want to manage from Azure Key Vault.</maml:para> <maml:para>To get the key identifier value, use the Get-AipServiceKeys 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Change the location of a legacy tenant key with a key in Azure Key Vault</maml:title> <dev:code>PS C:\>Convert-AipServiceKeyToKeyVault -KeyIdentifier aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"</dev:code> <dev:remarks> <maml:para>Changes the location of the original customer-managed key that has the key identifier of aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb with the location of a customer-managed key in Azure Key Vault, which is named contoso-aipservice-key and has the version number aaaabbbbcccc111122223333 in the Contoso key vault.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045022</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Use-AipServiceKeyVaultKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Planning and implementing your Azure Information Protection tenant key</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key</maml:uri> </maml:navigationLink> </command: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>Disable-AipService</command:name> <command:verb>Disable</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Deactivates the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipService cmdlet deactivates the protection service from Azure Information Protection for your tenant.</maml:para> <maml:para>You can also do this action in a management portal. For more information, see Decommissioning and deactivating Azure Information Protection service (https://docs.microsoft.com/rights-management/deploy-use/decommission-deactivate)on the Microsoft documentation site. </maml:para> <maml:para>Deactivate the protection service only if you no longer want to protect documents and emails by using Azure Information Protection and you no longer need access to content that was previously protected by using Azure Information Protection.</maml:para> <maml:para>If you accidentally deactivate the protection service or change your mind, you can simply activate it again by using the Enable-AipService cmdlet to resume using the service. However, if you are deactivating the service because you no longer want to use protection from Azure Information Protection, you might need to take additional steps. For more information, see Decommissioning and deactivating Azure Rights Management (https://docs.microsoft.com/rights-management/deploy-use/decommission-deactivate).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Disable the protection service ----------</maml:title> <dev:code>PS C:\>Disable-AipService</dev:code> <dev:remarks> <maml:para>This command deactivates the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044839</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Disable-AipServiceDevicePlatform</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Disables protection support from Azure Information Protection for device platforms.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceDevicePlatform cmdlet disables protection support from Azure Information Protection for device platforms. For information about supported device platforms, see the Enable-AipServiceDevicePlatform cmdlet.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet disables protection support for all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet disables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet disables protection support for all device platforms.</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" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet disables protection support for the specified device platform.</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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet disables protection support for the specified device platform.</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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Disable protection support for device platforms --</maml:title> <dev:code>PS C:\>Disable-AipServiceDevicePlatform -WindowsPhone -WindowStore</dev:code> <dev:remarks> <maml:para>This command disables protection support for Windows Phone and Windows Store device platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Disable protection support for all device platforms</maml:title> <dev:code>PS C:\>Disable-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command disables protection support for all device platforms.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045122</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Disable-AipServiceDocumentTrackingFeature</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Disables document tracking for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceDocumentTrackingFeature cmdlet disables the document tracking feature for Azure Information Protection. This cmdlet disables access to the document tracking site so that all users in your organization cannot track or revoke access to documents that they have protected. In addition, activity related to shared documents (who opened them, when, from which location) is not logged to the document tracking site. For example, if you later enable the document tracking site, users will see the documents that they protected while the site was disabled but cannot see who opened them.</maml:para> <maml:para>You must use PowerShell to disable document tracking; you cannot do this configuration by using a management portal.</maml:para> <maml:para>Document tracking is enabled by default for an organization using the protection service from Azure Information Protection, but you might need to disable this feature for privacy requirements that are specific to your organization or region. This setting is organization-wide; you cannot disable document tracking for some users in your organization and not for others.</maml:para> <maml:para>When document tracking is disabled, users still see options that refer to tracking and revocation in applications such as Word and File Explorer, and the Azure Information Protection client. However, when users access the document tracking site, they see the following message: Your administrator has disabled document tracking for your organization. Contact your administrator for details. You can disable document tracking either before you activate the protection service for Azure Information Protection, or after. After you have disabled document tracking, you can re-enable it at any time.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceDocumentTrackingFeature</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <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" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Disable document tracking -------------</maml:title> <dev:code>PS C:\>Disable-AipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command disables document tracking for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045125</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Disable-AipServiceIPCv3</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Disables the MSIPC v3 platform for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceIPCv3 cmdlets disables the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support the protection service from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Disable the MSIPC v3 platform for iOS and Android devices</maml:title> <dev:code>PS C:\>Disable-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command disables the MSIPC v3 platform so that iOS and Android mobile devices cannot use the protection service.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044846</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Disable-AipServiceSuperUserFeature</command:name> <command:verb>Disable</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Disables the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AipServiceSuperUserFeature cmdlet disables the super user feature for Azure Information Protection. This action does not automatically remove the previously added users or group from the super user list, and they continue to be displayed when you run the Get-AipServiceSuperUser or Get-AipServiceSuperUserGroup cmdlets. Therefore, if you enable the super user feature again, these users are automatically super users again, until you manually remove them.</maml:para> <maml:para>If there are users in the current super list who must not be a super user if this feature is enabled again, remove them from the super user list before you disable the super user feature. If these users are individually specified, remove them with the Remove-AipServiceSuperUser cmdlet. If they are a member of a group that you have specified to be a super user group, either remove those users from the specified super user group, or remove the super user group by using the Clear-AipServiceSuperUserGroup cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For information about the super user feature for Azure Information Protection, see Enable-AipServiceSuperUserFeature.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Disable the super user feature ----------</maml:title> <dev:code>PS C:\>Disable-AipServiceSuperUserFeature</dev:code> <dev:remarks> <maml:para>This command disables the super user feature for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=400599</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Disconnect-AipService</command:name> <command:verb>Disconnect</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Disconnects from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-AipService cmdlet disconnects you from the protection service from Azure Information Protection. Use this cmdlet to end a connection that you previously established by using the Connect-AipService cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Disconnect from Azure Information Protection ---</maml:title> <dev:code>PS C:\>Disconnect-AipService</dev:code> <dev:remarks> <maml:para>This command disconnects you from the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044860</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Enable-AipService</command:name> <command:verb>Enable</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Activates the protection service for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipService cmdlet activates the protection service from Azure Information Protection so that all users in your tenant can protect documents and emails. </maml:para> <maml:para>You can also do this action in a management portal. For more information, see Activating the protection service from Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/activate-service). </maml:para> <maml:para>When you activate the protection service, you turn on this service for all rights-enabled applications and services for your tenant, but some applications and services and might need further configuration before they can use the protection capabilities from Azure Information Protection.</maml:para> <maml:para>For information about other deployment steps that might be needed, see the deployment roadmap (https://docs.microsoft.com/information-protection/plan-design/deployment-roadmap).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Enable the protection service -----------</maml:title> <dev:code>PS C:\>Enable-AipService</dev:code> <dev:remarks> <maml:para>This command activates the protection service for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044863</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Activating the protection service from Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/activate-service</maml:uri> </maml:navigationLink> </command: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>Enable-AipServiceDevicePlatform</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Enables protection support from Azure Information Protection for device platforms.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceDevicePlatform cmdlet enables protection support from Azure Information Protection for device platforms. Your tenant can support any combination of the following device platforms: - Android</maml:para> <maml:para>- iOS</maml:para> <maml:para>- Macintosh operating system</maml:para> <maml:para>- Web</maml:para> <maml:para>- Windows operating system</maml:para> <maml:para>- Windows Phone</maml:para> <maml:para>- Windows Store</maml:para> <maml:para></maml:para> <maml:para>To support all platforms, specify the All parameter.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet enables protection support for all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet enables protection support for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet enables protection support for all device platforms.</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" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet enables protection support for the specified device platform.</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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet enables protection support for the specified device platform.</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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Enable protection support for device platforms --</maml:title> <dev:code>PS C:\>Enable-AipServiceDevicePlatform -WindowsPhone -WindowStore</dev:code> <dev:remarks> <maml:para>This command enables protection support for device platforms for Windows Phone and Windows Store device platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Enable protection support for all device platforms </maml:title> <dev:code>PS C:\>Enable-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command enables protection support for all device platforms.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044865</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Enable-AipServiceDocumentTrackingFeature</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Enables document tracking for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceDocumentTrackingFeature cmdlet enables the document tracking feature for Azure Information Protection. This cmdlet enables access to the document tracking site so that users can track or revoke access to documents that they have protected. This setting is organization-wide; you cannot enable document tracking for some users in your organization and not for others.</maml:para> <maml:para>You must use PowerShell to enable document tracking; you cannot do this configuration by using a management portal.</maml:para> <maml:para>By default, document tracking is enabled, so you would run this cmdlet only if somebody had previously disabled document tracking for your tenant. When document tracking is enabled, users can access the document tracking site to see the protected documents that they have shared to date. Activity related to shared documents (who opened them, when, from which location) is shown for only when the document tracking site is enabled. For example, a user could revoke a document that they shared when document tracking was disabled but they cannot not see who opened this document when document tracking was disabled.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceDocumentTrackingFeature</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <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" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Enable document tracking -------------</maml:title> <dev:code>PS C:\>EnableAipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command enables document tracking for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044867</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Enable-AipServiceIPCv3</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Enables the MSIPC v3 platform for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceIPCv3 cmdlets enables the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support the protection service from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to do this configuration; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Enable the MSIPC v3 platform for iOS and Android devices</maml:title> <dev:code>PS C:\>Enable-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command enables the MSIPC v3 platform so that iOS and Android mobile devices can use the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045030</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Enable-AipServiceSuperUserFeature</command:name> <command:verb>Enable</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Enables the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AipServiceSuperUserFeature cmdlet enables the super user feature for your tenant's protection service from Azure Information Protection. When this feature is enabled, any users that are defined as super users for your organization (individually or by the super user group) can decrypt content that your tenant protected, and can remove protection from this content, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams. </maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>By default, the super user feature is not enabled, and no users are assigned to this feature. To assign users, you must use Add-AipServiceSuperUser or Set-AipServiceSuperUserGroup.</maml:para> <maml:para>Caution: We recommend that you enable the super user feature on an as-needed basis. During standard operations, we recommend that you disable the super user feature, unless you use it to provide a trusted application with the ability to decrypt rights-protected content. For example, this exception might be needed for an application to scan the contents of a file for malware.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Enable the super user feature -----------</maml:title> <dev:code>PS C:\>Enable-AipServiceSuperUserFeature</dev:code> <dev:remarks> <maml:para>This command enables the super user feature for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044936</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Export-AipServiceTemplate</command:name> <command:verb>Export</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Exports the properties of a protection template from Azure Information Protection to a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Export-AipServiceTemplate cmdlet exports all the properties of a protection template from Azure Information Protection to a file. You can then import the template to another tenant using Azure Information Protection, or you can edit the exported template and import it back to the original tenant. You can use this technique to perform bulk edits of complex properties in templates, such as multilingual names and descriptions.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to export and import these templates.</maml:para> <maml:para>Tip: Consider using this cmdlet as a way to back up your protection templates, so that you can revert to a known-good version if required.</maml:para> <maml:para>The export process does not automatically append a file name extension, so you can specify a file name extension to match the application that you will use to view and edit the resulting data.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to get the GUIDs of all templates.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites an existing template file that has the same path.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the location where you want to save the 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites an existing template file that has the same path.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the location where you want to save the 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Export a template -----------------</maml:title> <dev:code>PS C:\>Export-AipServiceTemplate -Path "C:\MyTemplates\MyTemplateFile.xml" -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428</dev:code> <dev:remarks> <maml:para>This command exports the specified template to the file named MyTemplateFile.xml.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045037</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipService</command:name> <command:verb>Get</command:verb> <command:noun>AipService</command:noun> <maml:description> <maml:para>Gets the activation status of the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipService cmdlet gets the activation status of the protection service from Azure Information Protection for your tenant. The status of the protection service is enabled (activated) or disabled (deactivated).</maml:para> <maml:para>You can also view this information in a management portal. For more information, see Activating the protection service from Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/activate-service).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Get the status of the protection service -----</maml:title> <dev:code>PS C:\>Get-AipService</dev:code> <dev:remarks> <maml:para>This command gets your tenant's activation status of the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044945</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipService</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceAdminLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceAdminLog</command:noun> <maml:description> <maml:para>Generates logs for all protection commands for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceAdminLog cmdlet generates logs for all administrative protection commands for Azure Information Protection. You can specify a start time and stop time of entries to include.</maml:para> <maml:para>You must use PowerShell to get these admin logs; you cannot do this action by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceAdminLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites, without prompting for confirmation, an existing log file that has the same path.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path and a file name for the log.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet overwrites, without prompting for confirmation, an existing log file that has the same path.</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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path and a file name for the log.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Generate a log of all commands ----------</maml:title> <dev:code>PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log"</dev:code> <dev:remarks> <maml:para>This command generates a log that contains all the administrative protection commands that have been run for your tenant.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Generate a log of commands for a specified time period</maml:title> <dev:code>PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log" -FromTime "05/01/2015 00:00:00" -ToTime "05/31/2015 23:59:59"</dev:code> <dev:remarks> <maml:para>This command generates a log of administrative protection commands that have been run for your tenant, limited to items that fall within the specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in May 2015, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Generate a log of commands for the last 45 days --</maml:title> <dev:code>PS C:\>$days = (Get-Date).AddDays(-45) PS C:\>Get-AipServiceAdminLog -Path "C:\Temp\AdminLog.log" -FromTime $days</dev:code> <dev:remarks> <maml:para>This command generates a log of administrative protection commands for your tenant, limited to items within the last 45 days (inclusive). The first command sets the variable for the FromTime parameter to be today's date minus 45 days. Then the second command gets the entries from the log for this time period, by using this variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045046</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Date</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293966</maml:uri> </maml:navigationLink> </command: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-AipServiceConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceConfiguration</command:noun> <maml:description> <maml:para>Gets the Azure Information Protection configuration of your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceConfiguration cmdlet gets the current Azure Information Protection configuration of your tenant for the protection service.</maml:para> <maml:para>You must use PowerShell to see a full list of protection configuration values for your tenant; you cannot get this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Display Azure Information Protection configuration for the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceConfiguration BPOSId : 9c11c87a-ac8b-46a3-8d5c-f4d0b72ee29a AzureInformationProtectionServiceId : 5c6bb73b-1038-4eec-863d-49bded473437 LicensingIntranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/licensing LicensingExtranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/licensing CertificationIntranetDistributionPointUrl : https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/certification CertificationExtranetDistributionPointUrl: https://5c6bb73b-1038-4eec-863d-49bded473437.aipservice.na.aadrm.com/_wmcs/certification AdminConnectionUrl : https://admin.na.aadrm.com/admin/admin.svc/Tenants/5c6bb73b-1038-4eec-863d-49bded473437 AdminV2ConnectionUrl : https://admin.na.aadrm.com/adminV2/admin.svc/Tenants/5c6bb73b-1038-4eec-863d-49bded473437 OnPremiseDomainName : Keys : {c46b5d49-1c4c-4a79-83d1-ec12a25f3134} CurrentLicensorCertificateGuid : c46b5d49-1c4c-4a79-83d1-ec12a25f3134 Templates : { c46b5d49-1c4c-4a79-83d1-ec12a25f3134, 5c6d36g9-c24e-4222-7786e-b1a8a1ecab60} FunctionalState : Enabled SuperUsersEnabled : Disabled SuperUsers : {admin3@contoso.com, admin4@contoso.com} AdminRoleMembers : {Global Administrator -> 5834f4d6-35d2-455b-a134-75d4cdc82172, ConnectorAdministrator -> 5834f4d6-35d2-455b-a134-75d4cdc82172} KeyRolloverCount : 0 ProvisioningDate : 1/30/2014 9:01:31 PM IPCv3FunctionalState : Enabled DevicePlatformState : {Windows -> True, WindowsStore -> True, WindowsPhone -> True, Mac -> FciEnabledForConnectorAuthorization : True DocumentTrackingFeatureState : Enabled</dev:code> <dev:remarks> <maml:para>This command displays the current protection configuration for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044949</maml:uri> </maml:navigationLink> </command: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-AipServiceDevicePlatform</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDevicePlatform</command:noun> <maml:description> <maml:para>Gets the device platforms in your organization that support the protection service from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDevicePlatform cmdlet gets the device platforms in your organization that support the protection service from Azure Information Protection. For information about supported device platforms, see the Enable-AipServiceDevicePlatform cmdlet.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDevicePlatform</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet gets the protection support status of all device platforms.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AipServiceDevicePlatform</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet gets the protection support status for the specified device platform.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies all device platforms. The cmdlet gets the protection support status of all device platforms.</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" aliases="none"> <maml:name>Android</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Android device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Macintosh operating system device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>Web</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the web device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>Windows</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows operating system device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>WindowsPhone</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Phone device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>WindowsStore</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the Windows Store device platform. The cmdlet gets the protection support status for the specified device platform.</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" aliases="none"> <maml:name>iOS</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet specifies the iOS device platform. The cmdlet gets the protection support status for the specified device platform.</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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get specific device platforms that support the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceDevicePlatform -WindowsPhone -WindowStore Key Value ----- ------ WindowsStore True WindowsPhone True</dev:code> <dev:remarks> <maml:para>This command determines whether Windows Phone and Windows Store device platforms in your organization support the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all device platforms that support the protection service</maml:title> <dev:code>PS C:\>Get-AipServiceDevicePlatform -All</dev:code> <dev:remarks> <maml:para>This command determines which of all device platforms in your tenant support the protection service from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045055</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDevicePlatform</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceDocumentLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDocumentLog</command:noun> <maml:description> <maml:para>Gets protection information about documents that are tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDocumentLog cmdlet returns protection information about the tracked documents for a specified user if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. This cmdlet helps to answer the question "How are documents protected for a specified user?" The information returned includes:</maml:para> <maml:para>- The document content ID, with the document name if available.</maml:para> <maml:para>- The Rights Management owner and Rights Management issuer.</maml:para> <maml:para>- The users and groups that were granted access.</maml:para> <maml:para>- The protection template ID or specific usage rights that protects the document.</maml:para> <maml:para>- Any expiry, offline access, or revocation setting.</maml:para> <maml:para></maml:para> <maml:para>For more information about the Rights Management owner and IRights Management issuer (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights#rights-management-issuer-and-rights-management-owner).</maml:para> <maml:para>You can specify a start time and stop time of entries to include. The output is returned as a list of PowerShell objects in the PowerShell console.</maml:para> <maml:para>You can alternatively use the document tracking site to get the protection information about the tracked documents. For more information, see the Tracking and revoking documents for users (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#tracking-and-revoking-documents-for-users)section in the Azure Information Protection client admin guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDocumentLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the protection information for documents if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. Group addresses are not supported with this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the protection information for documents if that user protected documents (the Rights Management issuer) or was the Rights Management owner for documents, or protected documents were configured to grant access directly to the user. Group addresses are not supported with this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get protection information about all tracked documents for a user</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentLog -UserEmail "test@contoso.com"</dev:code> <dev:remarks> <maml:para>This command gets protection information about the tracked documents for a user who has the email address of "test@contoso.com" and that user is the Rights Management issuer or Rights Management owner for the document, or the document was configured to grant access to that user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get protection information about tracked documents for a user, for a specific time period</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentLog -UserEmail "test@contoso.com" -FromTime "01/01/2018 00:00:00" -ToTime "01/31/2018 23:59:59"</dev:code> <dev:remarks> <maml:para>This command is the same as the previous example except that results are limited to documents that were protected within a specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in January 2018, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get protection information about all tracked documents for a user and save the results to a .csv file</maml:title> <dev:code>PS C:\>$documentLogs = Get-AipServiceDocumentLog -UserEmail "test@microsoft.com" PS C:\>$documentLogs | Export-Csv 'C:\Temp\DocumentLog.csv' -NoTypeInformation</dev:code> <dev:remarks> <maml:para>The first command gets the protection information about the tracked documents for a user who has the email address of "test@contoso.com" and that user is the Rights Management issuer or Rights Management owner for the document, or the document was configured to grant access to that user. The information is saved in a variable.</maml:para> <maml:para>The second command then uses the Export-Csv (https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/export-csv?view=powershell-4.0)cmdlet to convert the protection information into .csv format, and saves it to the C:\Temp\DocumentLog.csv file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044954</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTrackingLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceDocumentTrackingFeature</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDocumentTrackingFeature</command:noun> <maml:description> <maml:para>Indicates whether document tracking is enabled or disabled for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDocumentTrackingFeature cmdlet indicates whether the Azure Information Protection document tracking feature is enabled or disabled.</maml:para> <maml:para>You must use PowerShell to get this information about document tracking; you cannot get this information by using a management portal.</maml:para> <maml:para>For additional information about the document tracking site, see Configuring and using document tracking for Azure Information Protection (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking)from the Azure Information Protection client administrator guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDocumentTrackingFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example: Determine whether the document tracking site is enabled</maml:title> <dev:code>PS C:\>Get-AipServiceDocumentTrackingFeature</dev:code> <dev:remarks> <maml:para>This command determines whether the Azure Information Protection document tracking feature is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045059</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Gets the group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceDoNotTrackUserGroup cmdlet gets the email address of the currently configured group for the users who must not be tracked by the Azure Information Protection document tracking feature. </maml:para> <maml:para>This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>You must use PowerShell to retrieve this information; you cannot see it by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceDoNotTrackUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>This operation returns the group email address as a String . If a group has not been configured, an empty String is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Get-AipServiceDoNotTrackUserGroup</dev:code> <dev:remarks> <maml:para>This command gets the email address of the currently configured group for the users who will not be tracked with the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044894</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceIPCv3</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceIPCv3</command:noun> <maml:description> <maml:para>Displays whether the MSIPC v3 service is enabled or disabled for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceIPCv3 cmdlets displays the status of the MSIPC v3 platform on mobile devices such as iOS and Android. This platform must be enabled to support protection from Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceIPCv3</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example1: Display whether the MSIPC v3 platform for iOS and Android devices is enabled</maml:title> <dev:code>PS C:\>Get-AipServiceIPCv3</dev:code> <dev:remarks> <maml:para>This command displays whether the MSIPC v3 platform is enabled or disabled. This platform must be enabled on iOS and Android mobile devices to support protection from Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045170</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceIPCv3</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceKeys</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceKeys</command:noun> <maml:description> <maml:para>Lists all Azure Information Protection tenant keys associated with your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceKeys cmdlet lists all Azure Information Protection tenant keys associated with your tenant. The tenant keys include the initial tenant key that Microsoft generates for you, and any tenant keys that are stored in Azure Key Vault. For more information, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For security reasons, the cmdlet does not display the value of the tenant keys.</maml:para> <maml:para>When you run this cmdlet, you will see Status and KeyType :</maml:para> <maml:para>- The Status value shows Archived or Active . Archived identifies a tenant key that can be used to open previously protected content. Active identities the tenant key is currently in use to protect content.</maml:para> <maml:para>- The KeyType value shows Microsoft-managed or Customer-managed (BYOK) . Microsoft-managed identifies the tenant key as managed by Microsoft (the default). Customer-managed identifies the tenant key as managed by your organization in Azure Key Vault. For a customer-managed key, you also see Publickey , which shows the base-64 encoded public key that is associated with the KeyIdentifier and that corresponds to the same information that Azure Key Vault provides for your key.</maml:para> <maml:para>For security reasons, the cmdlet does not display the value of the Microsoft-managed key and displays only the public key information of customer-managed (BYOK) keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceKeys</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------- Example 1: Get keys ---------------------</maml:title> <dev:code>PS C:\>Get-AipServiceKeys</dev:code> <dev:remarks> <maml:para>This command lists all Azure Information Protection tenant keys associated with your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2044896</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTpd</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Planning and implementing your Azure Information Protection tenant key</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key</maml:uri> </maml:navigationLink> </command: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-AipServiceMaxUseLicenseValidityTime</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceMaxUseLicenseValidityTime</command:noun> <maml:description> <maml:para>Gets the maximum validity time for Rights Management use licenses from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceMaxUseLicenseValidityTime cmdlet gets the maximum validity time for your tenant, in days, for Azure Rights Management use licenses from Azure Information Protection. The default value is 30 days.</maml:para> <maml:para>You must use PowerShell to view this configuration at the organization level; you cannot view this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceMaxUseLicenseValidityTime</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get the maximum validity time -----------</maml:title> <dev:code>PS C:\>Get-AipServiceMaxUseLicenseValidityTime 30</dev:code> <dev:remarks> <maml:para>This command gets the maximum validity time for use licenses for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=529558https://go.microsoft.com/fwlink/?linkid=2045179</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceMaxUseLicenseValidityTime</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceMigrationUrl</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceMigrationUrl</command:noun> <maml:description> <maml:para>Gets the migration URL for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceMigrationUrl cmdlet gets the migration URL for Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to get this information; you cannot get the migration URL by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceMigrationUrl</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Get the migration URL ---------------</maml:title> <dev:code>PS C:\>Get-AipServiceMigrationUrl</dev:code> <dev:remarks> <maml:para>This command gets the migration URL for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2092222</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceMigrationUrl</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceOnboardingControlPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceOnboardingControlPolicy</command:noun> <maml:description> <maml:para>Gets the user on-boarding control policy for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceOnboardingControlPolicy cmdlet obtains your Azure Information Protection user on-boarding control policy to support a gradual deployment by controlling which users in your organization can protect content by using Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to view this configuration; you cannot view this configuration by using a management portal.</maml:para> <maml:para>This control can be based on assigned user licenses for the Azure Rights Management service or membership in a designated security group. You can also define whether the policy applies to just mobile devices, just Windows clients, or mobile devices and Windows clients. For more information, see Set-AipServiceOnboardingControlPolicy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceOnboardingControlPolicy</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get the user on-boarding control policy ------</maml:title> <dev:code>PS C:\> Get-AipServiceOnboardingControlPolicy</dev:code> <dev:remarks> <maml:para>This command displays the user on-boarding control policy for Azure Information Protection for your organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045203</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceOnboardingControlPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceRoleBasedAdministrator</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Gets the role-based administrators for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceRoleBasedAdministrator cmdlet gets the role-based administrators for the protection service from Azure Information Protection. You can get the administrators for a specified role.</maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet gets the administrators that belong to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet gets the administrators that belong to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: List administrators ----------------</maml:title> <dev:code>PS C:\>Get-AipServiceRoleBasedAdministrator</dev:code> <dev:remarks> <maml:para>This command lists the role-based administrators for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045180</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceSuperUser</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Gets the super users for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUser cmdlet gets the super users for Azure Information Protection, who can unprotect or protect files for your organization when the super user feature is enabled by using the Enable-AipServiceSuperUserFeature cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUser</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: List super users -----------------</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUser</dev:code> <dev:remarks> <maml:para>This command lists the super users for Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045209</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configuring super users for Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command: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-AipServiceSuperUserFeature</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUserFeature</command:noun> <maml:description> <maml:para>Gets the status of the super user feature for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUserFeature cmdlet gets the status of the super user feature for Azure Information Protection for your organization. The super user feature can be enabled or disabled. By default, it is disabled.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users)on the Microsoft documentation site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUserFeature</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Get the status of the super user feature -----</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUserFeature Enabled</dev:code> <dev:remarks> <maml:para>This command gets the status (Enabled or Disabled) of the super user feature in your organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045212</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command: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-AipServiceSuperUserGroup</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Gets the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceSuperUserGroup cmdlet gets the email address of the Azure Information Protection super user group for your organization. This cmdlet does not get users that are individually assigned as super users with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceSuperUserGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>This operation returns the super user group email address as a String . If no super user group exists, an empty String is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get the super user group -------------</maml:title> <dev:code>PS C:\>Get-AipServiceSuperUserGroup</dev:code> <dev:remarks> <maml:para>This command gets the email address of the super user group for an organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045194</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configuring super users for Azure Information Protection and discovery services or data recovery</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/configure-super-users</maml:uri> </maml:navigationLink> </command: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-AipServiceTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Gets a list of protection templates for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTemplate cmdlet gets all existing or selected protection templates from Azure Information Protection. Use the TemplateID parameter to get a specific template. If you do not specify the TemplateId , all templates are retrieved.</maml:para> <maml:para>Similar configuration information can also be viewed in the Azure portal, but this cmdlet also returns the template GUID that isn't available in the portal.</maml:para> <maml:para>The cmdlet output is a list of template objects that contain all the template properties that you can use for further processing. The output of this command displays the template GUID, name, and description in the current locale. For additional template properties, such as usage rights and whether the template is published or archived, use the Get-AipServiceTemplateProperty cmdlets.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TemplateID</maml:name> </dev:type> <maml:description> <maml:para>Specifies the GUID of the protection template to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>This cmdlet outputs a list comprising all protection templates for the tenant, or for a selected template.</maml:para> <maml:para>If no name is defined for a template in the current locale, "No name defined in language-code" is returned as the name for that template.</maml:para> <maml:para>If no description is defined for a template in the current locale, "No description defined in language-code" is returned as the description for that template.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Get all templates -----------------</maml:title> <dev:code>PS C:\> Get-AipServiceTemplate</dev:code> <dev:remarks> <maml:para>This command gets all templates for your tenant, so you can get the template ID that you want to use, by identifying the template by its name and description.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Get a specific template --------------</maml:title> <dev:code>PS C:\> Get-AipServiceTemplate -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428</dev:code> <dev:remarks> <maml:para>This command gets a specific template, specified by its template ID (GUID), so that you can confirm from its name and description that it is the template that you want to use.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045197</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceTemplateProperty</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTemplateProperty</command:noun> <maml:description> <maml:para>Gets the properties of a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTemplateProperty cmdlet gets specified properties of a protection template for Azure Information Protection, by using the TemplateId parameter.</maml:para> <maml:para>Similar configuration information can also be viewed in the Azure portal, but this cmdlet also includes the template GUID.</maml:para> <maml:para>You can query properties of a default template, or a custom template. For more information about custom templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTemplateProperty</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Lists the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Gets the content expiration configuration setting for content that is protected with the template.</maml:para> <maml:para>One of the following values is returned:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days from the day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to AfterDays.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Lists the descriptions for the template in all locales.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Indicates the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box when you configure APPLICATION COMPATIBILITY in the Azure classic portal (now retired). There is no equivalent setting in the Azure portal.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days content is accessible offline after a license to consume it is acquired.</maml:para> <maml:para>-1 indicates unlimited access.</maml:para> <maml:para>0 indicates that a license must be obtained for each use and that content is only available online.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Lists the names for the template in all locales.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Indicates whether the template is a default template (True) and therefore cannot be edited or deleted, or a custom template (False) and therefore can be edited or deleted by an administrator.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Lists the rights granted to users or groups for the content that is protected with the template.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The status of the template:</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not displayed to users.</maml:para> <maml:para>-- Published templates are available to users to protect content.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to obtain the template ID of all templates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Lists the date on which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</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" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Gets the content expiration configuration setting for content that is protected with the template.</maml:para> <maml:para>One of the following values is returned:</maml:para> <maml:para>- Never . Indicates that content is available indefinitely.</maml:para> <maml:para>- OnDate . Indicates that content expires at a certain fixed date.</maml:para> <maml:para>- AfterDays . Indicates that content is available for the indicated number of days after it is protected.</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" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days from the day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to AfterDays.</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" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Lists the descriptions for the template in all locales.</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" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Indicates the behavior of a departmental template in applications that do not support departmental templates (see the ScopedIdentities parameter).</maml:para> <maml:para>If set to True and the template is a departmental template, all users trying to protect content from an application that does not support departmental templates will see the template and therefore be able to select it, regardless of whether the users are members of the template's target scope or not.</maml:para> <maml:para>If set to False, no users see and therefore cannot select the template in applications that do not support departmental templates, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on applications that natively support departmental templates.</maml:para> <maml:para>This parameter is functionally the equivalent of the Show this template to all users when the applications do not support user identity check box when you configure APPLICATION COMPATIBILITY in the Azure classic portal (now retired). There is no equivalent setting in the Azure portal.</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" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Lists the number of days content is accessible offline after a license to consume it is acquired.</maml:para> <maml:para>-1 indicates unlimited access.</maml:para> <maml:para>0 indicates that a license must be obtained for each use and that content is only available online.</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" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Lists the names for the template in all locales.</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" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Indicates whether the template is a default template (True) and therefore cannot be edited or deleted, or a custom template (False) and therefore can be edited or deleted by an administrator.</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" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Lists the rights granted to users or groups for the content that is protected with the template.</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" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</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" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The status of the template:</maml:para> <maml:para>- Archived templates are available to consume previously protected content but are not displayed to users.</maml:para> <maml:para>-- Published templates are available to users to protect content.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to obtain the template ID of all templates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get the description and the usage rights for a template</maml:title> <dev:code>PS C:\>Get-AipServiceTemplateProperty -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428 -Descriptions -RightsDefinitions</dev:code> <dev:remarks> <maml:para>This command gets the description and the usage rights for all users or groups that are configured for the specified protection template.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: For all templates, get the name, the usage rights, whether a default template, and whether published or archived</maml:title> <dev:code>PS C:\>$templates = Get-AipServiceTemplate PS C:\>foreach ($template in $templates) {Get-AipServiceTemplateProperty -TemplateId $template.TemplateId -Name -RightsDefinitions -ReadOnly -Status}</dev:code> <dev:remarks> <maml:para>The first command gets all the template IDs and stores them in a variable. The second command then uses this variable to get the template name, the usage rights, whether it is read-only (True for a default template, False for a custom template), and the status (Published or Archived) for each template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045221</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceTrackingLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceTrackingLog</command:noun> <maml:description> <maml:para>Gets tracking information for documents protected by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceTrackingLog cmdlet returns tracking information about protected documents for a specified user who protected documents (the Rights Management issuer) or who accessed protected documents. This cmdlet helps to answer the question "Which protected documents did a specified user track or access?" Information returned includes:</maml:para> <maml:para>- The document content ID, with the document name if available.</maml:para> <maml:para>- The Rights Management issuer.</maml:para> <maml:para>- The users who accessed the document, when, and from what location.</maml:para> <maml:para>- What protection template ID or specific usage rights were used to protect the document and whether access was granted or denied.</maml:para> <maml:para></maml:para> <maml:para>You can specify a start time and stop time of entries to include. The output is returned as a list of PowerShell objects in the PowerShell console.</maml:para> <maml:para>You can alternatively use the document tracking site to get the protection information about the tracked documents. For more information, see the Tracking and revoking documents for users (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#tracking-and-revoking-documents-for-users)section in the admin guide.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceTrackingLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the tracking information for documents that were protected by, or accessed by the user who has this email address.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>FromTime</maml:name> <maml:Description> <maml:para>Specifies the start time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToTime</maml:name> <maml:Description> <maml:para>Specifies the stop time (inclusive) for the log file as a DateTime object. To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet. Specify the date and time according to your system locale settings. For more information, type `Get-Help Get-Date`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserEmail</maml:name> <maml:Description> <maml:para>Specifies the email address of the user. The cmdlet gets the tracking information for documents that were protected by, or accessed by the user who has this email address.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get all tracking information for a user ------</maml:title> <dev:code>PS C:\>Get-AipServiceTrackingLog -UserEmail "test@contoso.com"</dev:code> <dev:remarks> <maml:para>This command generates a log of all the tracking information for documents that were protected by or accessed by the user with the email address "test@contoso.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get tracking information for a user, for a specific time period</maml:title> <dev:code>PS C:\>Get-AipServiceTrackingLog -UserEmail "test@contoso.com" -FromTime "01/01/2018 00:00:00" -ToTime "01/31/2018 23:59:59"</dev:code> <dev:remarks> <maml:para>This command is the same as the previous example except that the results are limited to documents that were tracked within a specific time period by using the FromTime and ToTime parameters. In this example, the time period is all days in January 2018, using the US date format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get all tracking information for a user and save the results to a .csv file</maml:title> <dev:code>PS C:\>$trackingLogs = Get-AipServiceTrackingLog -UserEmail "test@contoso.com" PS C:\>$trackingLogs | Export-Csv 'C:\Temp\TrackingLog.csv' -NoTypeInformation</dev:code> <dev:remarks> <maml:para>The first command generates a log of all the tracking information for documents that were protected by or accessed by the user with the email address "test@contoso.com", and saves the result in a variable.</maml:para> <maml:para>The second command then uses the Export-Csv (https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/export-csv?view=powershell-4.0)cmdlet to convert the tracking information into .csv format, and saves it to the C:\Temp\TrackingLog.csv file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045300</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDocumentLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceUserLog</command:name> <command:verb>Get</command:verb> <command:noun>AipServiceUserLog</command:noun> <maml:description> <maml:para>Downloads protection user logs from Azure Information Protection to local storage.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AipServiceUserLog cmdlet downloads protection user logs to local storage. You must specify either a specific date or a date range to download the log entries.</maml:para> <maml:para>You must use PowerShell to get these user logs; you cannot do this action by using a management portal.</maml:para> <maml:para>When you run this command and specify a date only for the DateTime objects, the time is assumed to be 00:00:00 in your local time, and then converted to UTC. </maml:para> <maml:para>When you specify a time with a date (for example, -ForDate "2/1/2016 15:00:00"), that date and time is converted to UTC. The Get-AipServiceUserLog command then gets the logs for that UTC time period. </maml:para> <maml:para>See the examples for how you might need to change your DateTime values, to accommodate the conversion needed for your local time.</maml:para> <maml:para>For more information about protection usage logging and a step-by-step example, see Logging and analyzing protection usage from Azure In formation Protection (https://docs.microsoft.com/information-protection/deploy-use/log-analyze-usage).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AipServiceUserLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForDate</maml:name> <maml:Description> <maml:para>Specifies a date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the FromDate parameter. </maml:para> <maml:para>To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet overwrites, without prompting for confirmation, an existing log file for the same date or date range.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>FromDate</maml:name> <maml:Description> <maml:para>Specifies the start date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the ForDate parameter.</maml:para> <maml:para>If you specify this parameter but not the ToDate , the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NumberOfThreads</maml:name> <maml:Description> <maml:para>Specifies the number of threads to use to download logs.</maml:para> <maml:para>The acceptable values for this parameter are: 1-32. </maml:para> <maml:para>The default value is 3.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path of the folder in which to save the logs.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:Description> <maml:para>Specifies the stop date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Optionally, specify this parameter when you use the FromDate parameter, to specify a specific date range. If you do not specify this parameter when you use the FromDate parameter, the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForDate</maml:name> <maml:Description> <maml:para>Specifies a date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the FromDate parameter. </maml:para> <maml:para>To obtain a DateTime object, use the Get-Date (https://go.microsoft.com/fwlink/?LinkID=293966)cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet overwrites, without prompting for confirmation, an existing log file for the same date or date range.</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" aliases="none"> <maml:name>FromDate</maml:name> <maml:Description> <maml:para>Specifies the start date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Use this parameter when you do not use the ForDate parameter.</maml:para> <maml:para>If you specify this parameter but not the ToDate , the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NumberOfThreads</maml:name> <maml:Description> <maml:para>Specifies the number of threads to use to download logs.</maml:para> <maml:para>The acceptable values for this parameter are: 1-32. </maml:para> <maml:para>The default value is 3.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies an existing path of the folder in which to save the logs.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:Description> <maml:para>Specifies the stop date (and optionally, a time) for the log file as a DateTime object.</maml:para> <maml:para>Optionally, specify this parameter when you use the FromDate parameter, to specify a specific date range. If you do not specify this parameter when you use the FromDate parameter, the end date is the day you run the command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Get user logs for a date range ----------</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -FromDate 12/12/2015 -ToDate 12/15/2015 -NumberOfThreads 10</dev:code> <dev:remarks> <maml:para>This command downloads user logs created between 12/12/2015 and 12/15/2015 (in UTC time) to the folder C:\Logs. </maml:para> <maml:para>The command uses 10 threads to download the logs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: Get user logs for a date -------------</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -ForDate 12/5/2015</dev:code> <dev:remarks> <maml:para>This command downloads the user logs for 12/5/2015 (in UTC time) to the folder C:\Logs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get user logs for a date, taking into account a UTC +offset time conversion</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -ForDate 2/2/2016 12:00:00</dev:code> <dev:remarks> <maml:para>This command shows how you might need to take into account a UTC +offset time conversion from your local time, before downloading user logs to the folder C:\Logs.</maml:para> <maml:para>You are in New Zealand, which means your computer's local time is UTC+12 and you want to download logs for 2/2/2016 for your local time rather than UTC. If you didn't specify the time of 12:00:00 with the date, your logs would contain data for only the first 12 hours of 2/2/2016 (and the last 12 hours of the previous day).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Get user logs for a date range, taking into account a UTC -offset time conversion</maml:title> <dev:code>PS C:\>Get-AipServiceUserLog -Path 'C:\Logs' -FromDate 2/1/2016 18:00:00 -ToDate 2/9/15/2016 18:00:00</dev:code> <dev:remarks> <maml:para>This command shows how you might need to take into account a UTC -offset time conversion from your local time before downloading user logs to the folder C:\Logs.</maml:para> <maml:para>You are in Houston, USA, which means your computer's local time is UTC-6 and you want to download logs from 2/2/2016 through 2/9/2016 for your local time rather than UTC. </maml:para> <maml:para>If you didn't specify the previous date and time of 18:00:00, your logs would be missing data for the first 6 hours of 2/2/2016 your local time (and an additional 6 hours for the ending date).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045502</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Date</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkID=293966</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Logging and analyzing protection usage by Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/deploy-use/log-analyze-usage</maml:uri> </maml:navigationLink> </command: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>Import-AipServiceTemplate</command:name> <command:verb>Import</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Creates a custom protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Import-AipServiceTemplate cmdlet creates a custom protection template for Azure Information Protection and sets its properties according to data contained in a template file.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to export and import these templates.</maml:para> <maml:para>The file you import must be a valid protection template file that has been exported from Azure Information Protection or AD RMS. The file can have any file name extension.</maml:para> <maml:para>If you import a template file identified by a GUID that matches the GUID of an existing template for the tenant, the original template is overwritten without warning. During the import operation, the GUID for the new template is set to the GUID in the input file, so the new template is valid to consume content protected with the imported template as long as Azure Information Protection has the necessary decryption keys.</maml:para> <maml:para>If the name of the template in the import file matches the name of an existing template for the tenant in any language, you will have two templates with the same name.</maml:para> <maml:para>You can store a maximum of 500 custom templates (published or archived) in Azure. If you can't import templates because you have reached this limit as a result of keeping many archived templates, consider exporting them to save the information locally and then removing these templates from Azure Information Protection.</maml:para> <maml:para>For more information about protection templates, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AipServiceTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the template file to import.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the template file to import.</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:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Import a template file --------------</maml:title> <dev:code>PS C:\>Import-AipServiceTemplate -Path "C:\MyTemplates\MyFile.xml"</dev:code> <dev:remarks> <maml:para>This command imports a template file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045508</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Import-AipServiceTpd</command:name> <command:verb>Import</command:verb> <command:noun>AipServiceTpd</command:noun> <maml:description> <maml:para>Imports a TPD from AD RMS for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Import-AipServiceTpd cmdlet imports an Active Directory Rights Management Services (AD RMS) trusted publishing domain (TPD) over the Internet into your tenant for Azure Information Protection, so that you can migrate your protection service from on-premises to the cloud. The TPD contains your private key and protection templates from AD RMS.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>This cmdlet always sets the key from the imported TPD to an archived state. After you run this command, the key in the imported TPD becomes available to Azure Information Protection to consume content that AD RMS protected by using this key. Use the Set-AipServiceKeyProperties cmdlet to change the state of the imported TPD to Active.</maml:para> <maml:para>Warning: Do not run this cmdlet unless you have read and understood the requirements, restrictions, instructions, and implications of migrating from AD RMS. For more information, see Migrating from AD RMS to Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/migrate-from-ad-rms-to-azure-rms).</maml:para> <maml:para>If you migrate templates from AD RMS as active, you can edit these templates in the Azure portal, or by using PowerShell. You can publish these templates so that users can select them from applications. If the migrated templates are not activated, they can only be used to open documents that they previously protected.</maml:para> <maml:para>You must use the AD RMS management console to export the TPD. If you use a hardware security module (HSM) for your keys, you must first repackage the TPD keys by using the Azure Key Vault BYOK tools. You can download these tools from the Microsoft Download Site (https://www.microsoft.com/download/details.aspx?id=45345). For more information, see [How to generate and transfer HSM-protected keys for Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-hsm-protected-keys).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AipServiceTpd</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab.</maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</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="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ProtectionPassword</maml:name> <maml:Description> <maml:para>Specifies the password that was used to encrypt the exported TPD file.</maml:para> <maml:para>You can use either ConvertTo-SecureString -AsPlaintext or Read-Host to specify the SecureString.</maml:para> <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides example of acceptable password in the proper format.")]--> <maml:para>When you use ConvertTo-SecureString and the password has special characters, enter the password between single quotes or escape the special characters. If you do not, the password will not parse correctly and in verbose mode, you will see the following error messages: VERBOSE: Trusted Publishing Domain data is corrupted. VERBOSE: The remote server returned an unexpected response: (400) Bad Request. For example, if your password is Pa$$word , enter 'Pa$$word' or Pa`$`$word so that Windows PowerShell can correctly parse the special characters. As a full example, you might type $pwd = ConvertTo-SecureString 'Pa$$w0rd' -AsPlainText -Force and then to check that the stored value is correct, type $pwd to confirm that Pa$$word is displayed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TpdFile</maml:name> <maml:Description> <maml:para>Specifies the TPD file exported from your AD RMS cluster to import to your tenant to use for Azure Information Protection.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab.</maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</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="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key in Azure Key Vault that you want to use for your tenant key. This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ProtectionPassword</maml:name> <maml:Description> <maml:para>Specifies the password that was used to encrypt the exported TPD file.</maml:para> <maml:para>You can use either ConvertTo-SecureString -AsPlaintext or Read-Host to specify the SecureString.</maml:para> <!--[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Help file provides example of acceptable password in the proper format.")]--> <maml:para>When you use ConvertTo-SecureString and the password has special characters, enter the password between single quotes or escape the special characters. If you do not, the password will not parse correctly and in verbose mode, you will see the following error messages: VERBOSE: Trusted Publishing Domain data is corrupted. VERBOSE: The remote server returned an unexpected response: (400) Bad Request. For example, if your password is Pa$$word , enter 'Pa$$word' or Pa`$`$word so that Windows PowerShell can correctly parse the special characters. As a full example, you might type $pwd = ConvertTo-SecureString 'Pa$$w0rd' -AsPlainText -Force and then to check that the stored value is correct, type $pwd to confirm that Pa$$word is displayed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TpdFile</maml:name> <maml:Description> <maml:para>Specifies the TPD file exported from your AD RMS cluster to import to your tenant to use for Azure Information Protection.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Import TPD with a software key ----------</maml:title> <dev:code>PS C:\>$Password = Read-Host -AsSecureString -Prompt "Password: " PS C:\> Import-AipServiceTpd -TpdFile "C:\aipservice_tpd.xml" -ProtectionPassword $Password -Verbose</dev:code> <dev:remarks> <maml:para>The first command creates a password as a secure string by using the Read-Host cmdlet, and then stores the secure string in the $Password variable. For more information, type `Get-Help Read-Host`.</maml:para> <maml:para>The second command imports a TPD with a software key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 2: Import TPD with an HSM key ------------</maml:title> <dev:code>PS C:\>$Password = Read-Host -AsSecureString -Prompt "Password: " PS C:\> Import-AipServiceTpd -TpdFile "C:\no_key_tpd.xml" -ProtectionPassword $Password -KeyVaultKeyUrl "https://contoso-byok-kv.vault.azure.net/keys/contosoaipservice-byok/aaaabbbbcccc111122223333" -FriendlyName "Contoso BYOK key" -Verbose</dev:code> <dev:remarks> <maml:para>The first command creates a password as a secure string, and then stores the secure string in the $Password variable.</maml:para> <maml:para>The second command imports a TPD to be used with a key that is stored in Azure Key Vault. Additionally, the command changes the friendly name of the key to "Contoso BYOK key".</maml:para> <maml:para>Our example uses the key vault name of contoso-byok-kv, the key name of contosoaipservice-byok, and the version number of aaaabbbbcccc111122223333.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045514</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceKeyProperties</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Migrating from AD RMS to Azure Information Protection</maml:linkText> <maml:uri>https://docs.microsoft.com/information-protection/plan-design/migrate-from-ad-rms-to-azure-rms</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>How to generate and transfer HSM-protected keys for Azure Key Vault</maml:linkText> <maml:uri>https://docs.microsoft.com/azure/key-vault/key-vault-hsm-protected-keys</maml:uri> </maml:navigationLink> </command: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>New-AipServiceRightsDefinition</command:name> <command:verb>New</command:verb> <command:noun>AipServiceRightsDefinition</command:noun> <maml:description> <maml:para>Creates a rights definition object for a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-AipServiceRightsDefinition cmdlet creates a rights definition object that you store as a variable and then use to create or update a protection template for Azure Information Protection when you use the Add-AipServiceTemplate or Set-AipServiceTemplateProperty cmdlet.</maml:para> <maml:para>A rights definition object expresses the usage rights that users have to content that Azure Information Protection protects. You can specify a user, a group, or all users in an organization. </maml:para> <maml:para>Similar configuration can also be done when you create or configure a protection template in the Azure portal, but this cmdlet offers more fine-grained control. However, this cmdlet does not support the any authenticated users option (https://docs.microsoft.com/azure/information-protection/deploy-use/configure-policy-protection#more-information-about-add-any-authenticated-users)that you can select in the Azure portal.</maml:para> <maml:para>Tip: You can this cmdlet to enable secure collaboration with other organizations when they have user accounts in Azure Active Directory and Office 365. For example, provide an external group VIEW and DOCEDIT rights to collaborate on a joint project. Or, provide VIEW rights to all users in a partner organization.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AipServiceRightsDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Specifies a domain name for your organization or another organization, to be used for granting rights when you create or update a protection template. When an organization has more than one domain, it does not matter which domain name you specify; users from all verified domains for that organization are automatically included. </maml:para> <maml:para>Specify one domain name only for all users in an organization; to grant rights to more than one organization, create another rights definition object.</maml:para> <maml:para>Note that for authentication to be successful for Azure AD, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory. </maml:para> <maml:para>You can specify domain names from social providers (such as gmail.com) but authentication for accounts that are not in Azure AD are supported for email only, and when Exchange Online is configured for the new capabilities for Office 365 Message Encryption.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. The user or group can be internal to your organization, or external. For Azure AD authentication to be successful, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory.</maml:para> <maml:para>Other authentication methods include email address from a social provider (for example, a Gmail account) when Exchange Online is configured for the new capabilities for Office 365 Message Encryption. Some applications also support personal email addresses with a Microsoft account. For more information about using Microsoft accounts for authentication, see the supported scenarios table (https://docs.microsoft.com/azure/information-protection/get-started/secure-collaboration-documents#supported-scenarios-for-opening-protected-documents). </maml:para> <maml:para>The cmdlet associates the rights that the Rights parameter specifies to the user or group that the address specifies.</maml:para> <maml:para>Tip: If you want to specify all users in your organization or all users in another organization, use the DomainName 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Rights</maml:name> <maml:Description> <maml:para>Specifies a list of rights. The list contains one or more of the following:</maml:para> <maml:para>- VIEW : Interpreted by most applications as allowed to present the data on the screen.</maml:para> <maml:para>- EDIT : Interpreted by most applications as allowed to modify content in the document and save it.</maml:para> <maml:para>- DOCEDIT : Interpreted by most applications as allowed to modify the content of the document.</maml:para> <maml:para>- EXTRACT : Interpreted by most applications as allowed to copy the content to the clipboard or otherwise extract the content in unencrypted form.</maml:para> <maml:para>- OBJMODEL : Interpreted by most applications as allowed to access the document programmatically; for example, by using macros.</maml:para> <maml:para>- EXPORT : Interpreted by most applications as allowed to save the file in unencrypted form. For example, this right allows you to save in a different file format that does not support protection.</maml:para> <maml:para>- PRINT : Interpreted by most applications as allowed to print the document.</maml:para> <maml:para>- OWNER : User has all rights on the document, including the ability to remove protection.</maml:para> <maml:para>- FORWARD : Interpreted by most applications as allowed to forward an email message, and to add recipients to the To and Cc lines.</maml:para> <maml:para>- REPLY : Interpreted by most applications as allowed to select reply to an email message, without allowing changes in the To or Cc lines.</maml:para> <maml:para>- REPLYALL : Interpreted by most applications as allowed to reply to all recipients of an email message, but does not allow the user to add recipients to the To or Cc lines.</maml:para> <maml:para>Note: For clarity, the documentation and display text from the module shows these rights as all upper-case letters. However, the values are not case-sensitive and you can specify them in lower or upper case.</maml:para> <maml:para>For more information about the usage rights, see Configuring usage rights for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Specifies a domain name for your organization or another organization, to be used for granting rights when you create or update a protection template. When an organization has more than one domain, it does not matter which domain name you specify; users from all verified domains for that organization are automatically included. </maml:para> <maml:para>Specify one domain name only for all users in an organization; to grant rights to more than one organization, create another rights definition object.</maml:para> <maml:para>Note that for authentication to be successful for Azure AD, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory. </maml:para> <maml:para>You can specify domain names from social providers (such as gmail.com) but authentication for accounts that are not in Azure AD are supported for email only, and when Exchange Online is configured for the new capabilities for Office 365 Message Encryption.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. The user or group can be internal to your organization, or external. For Azure AD authentication to be successful, the user must have an account in Azure Active Directory. Office 365 users automatically have an account in Azure Active Directory.</maml:para> <maml:para>Other authentication methods include email address from a social provider (for example, a Gmail account) when Exchange Online is configured for the new capabilities for Office 365 Message Encryption. Some applications also support personal email addresses with a Microsoft account. For more information about using Microsoft accounts for authentication, see the supported scenarios table (https://docs.microsoft.com/azure/information-protection/get-started/secure-collaboration-documents#supported-scenarios-for-opening-protected-documents). </maml:para> <maml:para>The cmdlet associates the rights that the Rights parameter specifies to the user or group that the address specifies.</maml:para> <maml:para>Tip: If you want to specify all users in your organization or all users in another organization, use the DomainName 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Rights</maml:name> <maml:Description> <maml:para>Specifies a list of rights. The list contains one or more of the following:</maml:para> <maml:para>- VIEW : Interpreted by most applications as allowed to present the data on the screen.</maml:para> <maml:para>- EDIT : Interpreted by most applications as allowed to modify content in the document and save it.</maml:para> <maml:para>- DOCEDIT : Interpreted by most applications as allowed to modify the content of the document.</maml:para> <maml:para>- EXTRACT : Interpreted by most applications as allowed to copy the content to the clipboard or otherwise extract the content in unencrypted form.</maml:para> <maml:para>- OBJMODEL : Interpreted by most applications as allowed to access the document programmatically; for example, by using macros.</maml:para> <maml:para>- EXPORT : Interpreted by most applications as allowed to save the file in unencrypted form. For example, this right allows you to save in a different file format that does not support protection.</maml:para> <maml:para>- PRINT : Interpreted by most applications as allowed to print the document.</maml:para> <maml:para>- OWNER : User has all rights on the document, including the ability to remove protection.</maml:para> <maml:para>- FORWARD : Interpreted by most applications as allowed to forward an email message, and to add recipients to the To and Cc lines.</maml:para> <maml:para>- REPLY : Interpreted by most applications as allowed to select reply to an email message, without allowing changes in the To or Cc lines.</maml:para> <maml:para>- REPLYALL : Interpreted by most applications as allowed to reply to all recipients of an email message, but does not allow the user to add recipients to the To or Cc lines.</maml:para> <maml:para>Note: For clarity, the documentation and display text from the module shows these rights as all upper-case letters. However, the values are not case-sensitive and you can specify them in lower or upper case.</maml:para> <maml:para>For more information about the usage rights, see Configuring usage rights for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-usage-rights).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Create a rights definition object for a user ---</maml:title> <dev:code>PS C:\>$R1 = New-AipServiceRightsDefinition -EmailAddress "ElisaDaugherty@Contoso.com" -Rights "VIEW","DOCEDIT"</dev:code> <dev:remarks> <maml:para>This command creates a rights definition object for the specified user and stores this policy in a variable named R1, which can then be used to create or update a protection template. </maml:para> <maml:para>The command includes the rights VIEW and DOCEDIT for a user in the Contoso organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Create a rights definition object for all users --</maml:title> <dev:code>PS C:\>$R2 = New-AipServiceRightsDefinition -DomainName "Contoso.com" -Rights "VIEW"</dev:code> <dev:remarks> <maml:para>This command creates a rights definition object for the Contoso organization and stores this policy in a variable named R2, which can then be used to create or update a protection template. The command includes the VIEW right for all users in the Contoso organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045520</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceRoleBasedAdministrator</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceRoleBasedAdministrator</command:noun> <maml:description> <maml:para>Removes administrative rights from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceRoleBasedAdministrator cmdlet removes administrative rights from Azure Information Protection, so that administrators you have previously delegated to configure the protection service can no longer do so by using PowerShell commands.</maml:para> <maml:para>You must use PowerShell to configure delegated administrative control for the protection service from Azure Information Protection, you cannot do this configuration by using a management portal.</maml:para> <maml:para>To see the full list of delegated administrators for the protection service, use Get-AipServiceRoleBasedAdministrator. Run the Remove-AipServiceRoleBasedAdministrator cmdlet for each user or group that you want to remove from the list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to remove administrative rights from Azure Information Protection. If the user has no email address, specify the user's Universal Principal 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to remove administrative rights from Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AipServiceRoleBasedAdministrator</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GlobalAdministrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectorAdministrator</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group that should no longer have administrative rights for Azure Information Protection.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group to remove administrative rights from Azure Information Protection. If the user has no email address, specify the user's Universal Principal 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a user or group to remove administrative rights from Azure Information Protection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Specifies a role. The cmdlet removes an administrator that belongs to the role that you specify.</maml:para> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- ConnectorAdministrator</maml:para> <maml:para>- GlobalAdministrator</maml:para> <maml:para>If you do not specify a role, the cmdlet removes the administrator from the GlobalAdministrator role.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupDisplayName</maml:name> <maml:Description> <maml:para>Specifies the display name of a user or group that should no longer have administrative rights for Azure Information Protection.</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:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove administrative rights by using a display name</maml:title> <dev:code>PS C:\>Remove-AipServiceRoleBasedAdministrator -SecurityGroupDisplayName "Finance Employees"</dev:code> <dev:remarks> <maml:para>This command removes administrative rights from Azure Information Protection for the group that has a display name of "Finance Employees".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Remove administrative rights by using an email address</maml:title> <dev:code>PS C:\>Remove-AipServiceRoleBasedAdministrator -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command removes administrative rights from Azure Information Protection for the user who has an email address of "EvanNarvaez@Contoso.com".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045318</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceRoleBasedAdministrator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceSuperUser</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceSuperUser</command:noun> <maml:description> <maml:para>Removes a super user from Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceSuperUser cmdlet removes a user from the list of users who are individually granted super user privileges for your organization.</maml:para> <maml:para>This cmdlet does not remove a group or a user from that a group that is assigned super user privileges by using the Set-AipServiceSuperUserGroup cmdlet.</maml:para> <maml:para>For more information about super users, see the Get-AipServiceSuperUser cmdlet.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceSuperUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. </maml:para> <maml:para>The cmdlet removes the user or group identified by the email address that you specify.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of a user or group. </maml:para> <maml:para>The cmdlet removes the user or group identified by the email address that you specify.</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:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Remove a super user ----------------</maml:title> <dev:code>PS C:\>Remove-AipServiceSuperUser -EmailAddress "EvanNarvaez@Contoso.com"</dev:code> <dev:remarks> <maml:para>This command removes an individually specified super user from Azure Information Protection by specifying that user's email address.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045326</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-AipServiceTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>AipServiceTemplate</command:noun> <maml:description> <maml:para>Deletes a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AipServiceTemplate cmdlet deletes a protection template for Azure Information Protection.</maml:para> <maml:para>You can delete only templates that you have created for your organization. You can set default templates to an archived state but you cannot delete them.</maml:para> <maml:para>Although you can configure protection templates in the Azure portal, you must use PowerShell to remove these templates.</maml:para> <maml:para>After a template is deleted, content protected with that template might become inaccessible. Users who are super users can continue to access content that was previously protected with a template that is now deleted. For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> <maml:para>This cmdlet requires the template ID, which you can get with the Get-AipServiceTemplate cmdlet.</maml:para> <maml:para>This cmdlet performs the following operations:</maml:para> <maml:para>- Displays the template properties.</maml:para> <maml:para>- Warns that all content protected with this template may become inaccessible.</maml:para> <maml:para>- Asks to confirm whether to proceed.</maml:para> <maml:para>- Calls the service to remove the template with the specified GUID.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AipServiceTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of the protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of the protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Delete a template -----------------</maml:title> <dev:code>PS C:\>Remove-AipServiceTemplate -TemplateId 36546649-4944-4462-a409-74373a67b6dd</dev:code> <dev:remarks> <maml:para>This command deletes the specified template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045542</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceDoNotTrackUserGroup</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceDoNotTrackUserGroup</command:noun> <maml:description> <maml:para>Sets a group for the users who must not be tracked by Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceDoNotTrackUserGroup cmdlet sets a group for Azure Information Protection when you use document tracking and you have users who must not be tracked. This configuration might be needed for privacy requirements. For more information, see Privacy controls for your document tracking site (https://docs.microsoft.com/information-protection/rms-client/client-admin-guide-document-tracking#privacy-controls-for-your-document-tracking-site).</maml:para> <maml:para>If this cmdlet has been run before, running it again overwrites the group that was set previously. You can set only one group, but it can contain nested groups.</maml:para> <maml:para>You must use PowerShell to set this group so that users are not tracked; you cannot do this configuration by using a management portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceDoNotTrackUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of the group whose members will be exempt from being tracked with the document tracking feature.</maml:para> <maml:para>You can specify a group that contains individual users, or nested groups. The email address must be a valid group email address that already exists in the organization.</maml:para> <maml:para>Note: Global administrators can always track the activities of these members.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the email address of the group whose members will be exempt from being tracked with the document tracking feature.</maml:para> <maml:para>You can specify a group that contains individual users, or nested groups. The email address must be a valid group email address that already exists in the organization.</maml:para> <maml:para>Note: Global administrators can always track the activities of these members.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>Set-AipServiceDoNotTrackUserGroup -GroupEmailAddress "DoNotTrackUserGroup@contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets a group that has the email address of DoNotTrackUserGroup@contoso.com for the Contoso organization so that users in that group will not be tracked with the document tracking feature.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045407</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AipServiceSuperUserFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AipServiceDocumentTrackingFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceDoNotTrackUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceKeyProperties</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceKeyProperties</command:noun> <maml:description> <maml:para>Updates the properties of a tenant key object for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceKeyProperties cmdlet changes an Archived status for a specified key object for the tenant to be Active. Because there can be only one active tenant key at any one time, the previously active tenant key is automatically set to Archived.</maml:para> <maml:para>New users of Azure Information Protection immediately use the identified tenant key to protect content. Existing users of the service gradually transition from the previously active tenant key to the newly active tenant key, and this staggered transition can take a few weeks to complete. You can force the update on clients by re-initializing the user environment (also known as bootstrapping). Documents and files that were protected with the previously active tenant key remain accessible to authorized users by using the tenant key that is now archived.</maml:para> <maml:para>Setting the tenant key object status to Active also resigns all protection templates with the newly active tenant key. Because this can be a time-consuming operation, especially if you have many protection templates, we do not recommend that you run this operation frequently. </maml:para> <maml:para>To run this cmdlet, you must specify the KeyIdentifier for the tenant key object that you want to set to Active. To get this value, use the Get-AipServiceKeys cmdlet. </maml:para> <maml:para>Note that you cannot use this cmdlet to change an Active status to be Archived. To set a tenant key object to have a status of Archived, you must set another tenant key object to Active.</maml:para> <maml:para>For more information about the tenant key, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceKeyProperties</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Active</maml:name> <maml:Description> <maml:para>Sets the status of the tenant key object.</maml:para> <maml:para>This parameter can only be use with the value of $True, which sets the status to be Active. If you want to change the status of a tenant key object to Archived, you must set another tenant key object to Active.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier for the tenant key object. You can get this value by running Get-AipServiceKeys.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Active</maml:name> <maml:Description> <maml:para>Sets the status of the tenant key object.</maml:para> <maml:para>This parameter can only be use with the value of $True, which sets the status to be Active. If you want to change the status of a tenant key object to Archived, you must set another tenant key object to Active.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyIdentifier</maml:name> <maml:Description> <maml:para>Specifies the key identifier for the tenant key object. You can get this value by running Get-AipServiceKeys.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Change the status of a tenant key object to be active</maml:title> <dev:code>PS C:\> Set-AipServiceKeyProperties -Force -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -Active $True</dev:code> <dev:remarks> <maml:para>This command changes the status of a tenant key object from Archived to Active. The KeyIdentifier parameter identifies the tenant key object to change, and this value can be found by running Get-AipServiceKeys. The tenant key object that previously had a status of Active is automatically set to Archived.</maml:para> <maml:para>Because the command specifies the Force parameter, the command does not prompt you for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2045233</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceMaxUseLicenseValidityTime</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceMaxUseLicenseValidityTime</command:noun> <maml:description> <maml:para>Sets the maximum validity time for Rights Management use licenses for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceMaxUseLicenseValidityTime cmdlet sets the maximum validity time for use licenses that Azure Information Protection grants for your organization when it protects files and email messages. The default value is 30 days.</maml:para> <maml:para>You must use PowerShell to set this configuration at the organization level; you cannot do this configuration by using a management portal.</maml:para> <maml:para>A use license is a per-document certificate that is granted to a user who opens a protected file or email message. This certificate contains that user's rights for the file or email message and the encryption key that was used to encrypt the content, as well as additional access restrictions defined in the document's policy.</maml:para> <maml:para>When the validity period of the use license is expired for a file or email message, the user credentials must be submitted to Azure Information Protection again to open that content. If the credentials are cached, the user is not prompted, and this happens in the background but an Internet connection is still required to send the cached credentials. </maml:para> <maml:para>For example, if a user shares a protected file by email and the protected file has the default use license validity period of 30 days:</maml:para> <maml:para>- Anna opens the file immediately, authenticates to Azure Information Protection, and reads the file. The following day, she reads the file again but does not have an Internet connection. Because the use license validity period has not expired, she can read the file. She accesses the file again 30 days later when she has an Internet connection and re-authenticates with Azure Information Protection, so she could now continue to read the file without authenticating again for a further 30 days.</maml:para> <maml:para>- John does not open the file for 31 days. When he does, he has Internet access that lets him authenticates to Azure Information Protection, and he can then open and read the file. John can continue to re-open and read the file even if he does not have an Internet connection again for a further 30 days.</maml:para> <maml:para>- Amelia opens the file a week after it arrives, and then does not open it again for two months. When she tries to open it this second time, she does not have Internet access and so she cannot open the file.</maml:para> <maml:para>This setting at the tenant level can be overridden by a more restrictive setting in a protection template because of the LicenseValidityDuration parameter in the Set-AipServiceTemplateProperty and Add-AipServiceTemplate cmdlets, which administrators can also set in the Azure portal by configuring the offline access option, "Number of days the content is available without an Internet connection".</maml:para> <maml:para>When there are different values for the use license, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</maml:para> <maml:para>Because the use license validity time can be overridden with more restrictive values, when you change the default value by using this cmdlet, choose a maximum value that best suits your organization. </maml:para> <maml:para>Decide on the best compromise between security and offline access for longer periods:</maml:para> <maml:para>- The lower the value, the more often users will be authenticated (which requires an Internet connection) but is a more secure setting because users will more quickly pick up changes such as the document has been revoked or the usage rights have changed for the protected document.</maml:para> <maml:para>- The higher the value, the less frequently users will be authenticated (and can continue to access protected documents even without an Internet connection) and is less secure because it will take longer for users to pick up changes such as the document has been revoked or the usage rights have changed for the protected document.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceMaxUseLicenseValidityTime</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>MaxUseLicenseValidityTime</maml:name> <maml:Description> <maml:para>Specifies the maximum validity time (0 - 65535) for use licenses in days.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet sets the value for the maximum validity time for use licenses without prompting you for confirmation.</maml:para> </maml:Description> <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" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet sets the value for the maximum validity time for use licenses without prompting you for confirmation.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>MaxUseLicenseValidityTime</maml:name> <maml:Description> <maml:para>Specifies the maximum validity time (0 - 65535) for use licenses in days.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Set the maximum validity time -----------</maml:title> <dev:code>PS C:\>Set-AipServiceMaxUseLicenseValidityTime 60</dev:code> <dev:remarks> <maml:para>This command sets the maximum validity time for use licenses to be 60 days.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045417</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceMaxUseLicenseValidityTime</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceMigrationUrl</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceMigrationUrl</command:noun> <maml:description> <maml:para>Sets a migration URL for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceMigrationUrl cmdlet sets a migration URL for Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to set the migration URL; you cannot do this action by using a management portal.</maml:para> <maml:para>Setting a migration URL for newly protected content can help you to migrate from Azure Information Protection to a supported on-premises server. Do not use this cmdlet in isolation but in conjunction with the instructions from Decommissioning and deactivating protection for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/decommission-deactivate).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceMigrationUrl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies a URL for the domain to migrate.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sets the value of the migration URL even if there is an existing migration URL.</maml:para> </maml:Description> <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" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>Specifies a URL for the domain to migrate.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sets the value of the migration URL even if there is an existing migration URL.</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" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Set a migration URL ----------------</maml:title> <dev:code>PS C:\>Set-AipServiceMigrationUrl -Domain "aadrm.online.contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets a migration URL for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?LinkId=2092311</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceMigrationUrl</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceOnboardingControlPolicy</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceOnboardingControlPolicy</command:noun> <maml:description> <maml:para>Sets the user on-boarding control policy for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceOnboardingControlPolicy cmdlet sets the policy that controls user on-boarding for Azure Information Protection. This cmdlet supports a gradual deployment by controlling which users in your organization can protect content by using Azure Information Protection.</maml:para> <maml:para>You must use PowerShell to set this configuration; you cannot do this configuration by using a management portal.</maml:para> <maml:para>This control can be based on assigned user licenses for the service or membership in a designated security group. You can also define whether the policy applies to just mobile devices, just Windows clients, or mobile devices and Windows clients.</maml:para> <maml:para>If you use the assigned license option, you can assign licenses to users by using the Microsoft 365 admin center or by using Azure PowerShell and the Set-MsolUserLicense (https://docs.microsoft.com/en-us/powershell/module/msonline/set-msoluserlicense?view=azureadps-1.0) cmdlet from the Azure AD PowerShell administration module. You can also use the [Get-MsolAccountSku](https://docs.microsoft.com/en-us/powershell/module/msonline/get-msolaccountsku?view=azureadps-1.0)cmdlet to obtain the different types of licenses that you can assign in your organization.</maml:para> <maml:para>If you use the group membership option, you must specify a security group, which does not have to be mail-enabled and it can contain other groups. To specify the group, use the group GUID. For more information about the user and group requirements and how to find the group GUID, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare).</maml:para> <maml:para>For more information about the Azure AD PowerShell cmdlets, see Azure Active Directory PowerShell (https://docs.microsoft.com/powershell/azure/overview?view=azureadps-2.0).</maml:para> <maml:para>Note: This cmdlet does not stop users from consuming protected content or prevent administrators from configuring services for Azure Information Protection (for example, Exchange Online mail flow rules or SharePoint protected libraries). Instead, it is designed for user applications such as Office, so that users do not see the options or templates to use Azure Information Protection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceOnboardingControlPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet configures the on-boarding control policy even if there is already an on-boarding control policy for the organization.</maml:para> </maml:Description> <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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Specifies the types of applications to which the on-boarding policy applies.</maml:para> <maml:para>Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- WindowsApp</maml:para> <maml:para>- MobileApp</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WindowsApp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MobileApp</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OnboardingControlPolicyScope</command:parameterValue> <dev:type> <maml:name>OnboardingControlPolicyScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupObjectId</maml:name> <maml:Description> <maml:para>Specifies the object ID of a security group in Azure AD. If you try to specify the object ID of a distribution group, you will see an error.</maml:para> <maml:para>The specified group restricts which users can protect content by using Azure Information Protection. If you also enable license enforcement, only users that have an Azure Rights Management license assigned and are members of this specified group can protect content by using Azure Information Protection.</maml:para> <maml:para>You can use this parameter to implement a phased deployment of Azure Information Protection even if all users have an Azure Rights Management license assigned to them.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseRmsUserLicense</maml:name> <maml:Description> <maml:para>Specifies whether users without an Azure Rights Management license assigned to them can use Azure Information Protection to protect content. Users can always use Azure Information Protection to consume protected content regardless of this setting and their license assignment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs.</maml:para> <maml:para>The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet configures the on-boarding control policy even if there is already an on-boarding control policy for the organization.</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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Specifies the types of applications to which the on-boarding policy applies.</maml:para> <maml:para>Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- WindowsApp</maml:para> <maml:para>- MobileApp</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OnboardingControlPolicyScope</command:parameterValue> <dev:type> <maml:name>OnboardingControlPolicyScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SecurityGroupObjectId</maml:name> <maml:Description> <maml:para>Specifies the object ID of a security group in Azure AD. If you try to specify the object ID of a distribution group, you will see an error.</maml:para> <maml:para>The specified group restricts which users can protect content by using Azure Information Protection. If you also enable license enforcement, only users that have an Azure Rights Management license assigned and are members of this specified group can protect content by using Azure Information Protection.</maml:para> <maml:para>You can use this parameter to implement a phased deployment of Azure Information Protection even if all users have an Azure Rights Management license assigned to them.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseRmsUserLicense</maml:name> <maml:Description> <maml:para>Specifies whether users without an Azure Rights Management license assigned to them can use Azure Information Protection to protect content. Users can always use Azure Information Protection to consume protected content regardless of this setting and their license assignment.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs.</maml:para> <maml:para>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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Restrict Azure Information Protection to users who have a license and are members of a specified group</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $True -SecurityGroupObjectId "fba99fed-32a0-44e0-b032-37b419009501" -Scope All</dev:code> <dev:remarks> <maml:para>This command configures Azure Information Protection to allow only users who have an Azure Rights Management license to use Azure Information Protection to protect content. Further, the command requires users to be members of the security group with the specified object ID. The restriction applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Restrict Azure Information Protection to users who are members of a specified group</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $False -SecurityGroupObjectId "fba99fed-32a0-44e0-b032-37b419009501" -Scope All</dev:code> <dev:remarks> <maml:para>This command allows only users that are members of the security group with the specified object ID to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Restrict Azure Information Protection to users who have an Azure Rights Management license</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $True -Scope All</dev:code> <dev:remarks> <maml:para>This command allows only users who have an Azure Rights Management license assigned to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Do not restrict Azure Information Protection for users</maml:title> <dev:code>PS C:\> Set-AipServiceOnboardingControlPolicy -UseRmsUserLicense $False -Scope All</dev:code> <dev:remarks> <maml:para>This command allows all users to protect content by using Azure Information Protection. The command applies to Windows clients and mobile devices.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045236</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceOnboardingControlPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceSuperUserGroup</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceSuperUserGroup</command:noun> <maml:description> <maml:para>Sets the super user group for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceSuperUserGroup cmdlet specifies a group to use as the super user group for Azure Information Protection. Members of this group are then super users, which means they become an owner for all content that is protected by your organization. These super users can decrypt this protected content and remove protection from it, even if an expiration date has been set and expired. Typically, this level of access is required for legal eDiscovery and by auditing teams.</maml:para> <maml:para>You can specify any group that has an email address, but be aware that for performance reasons, group membership is cached. For information about group requirements, see Preparing users and groups for Azure Information Protection (https://docs.microsoft.com/information-protection/plan-design/prepare).</maml:para> <maml:para>If a super user group already exists, running this cmdlet overwrites it. This cmdlet does not affect users that are individually assigned as super users with the Add-AipServiceSuperUser cmdlet.</maml:para> <maml:para>An organization can have only one super user group in addition to multiple users who are assigned the privilege individually, but you can nest groups.</maml:para> <maml:para>You must use PowerShell to configure super users; you cannot do this configuration by using a management portal.</maml:para> <maml:para>For more information about super users, see Configuring super users for Azure Information Protection and discovery services or data recovery (https://docs.microsoft.com/information-protection/deploy-use/configure-super-users).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceSuperUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the group email address for the super user group. GroupEmailAddress can specify a group that contains individual users or other nested groups. It must be a valid group email address for an existing group in the organization.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupEmailAddress</maml:name> <maml:Description> <maml:para>Specifies the group email address for the super user group. GroupEmailAddress can specify a group that contains individual users or other nested groups. It must be a valid group email address for an existing group in the organization.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Set the super user group -------------</maml:title> <dev:code>PS C:\>Set-AipServiceSuperUserGroup -GroupEmailAddress "SuperUserGroup@contoso.com"</dev:code> <dev:remarks> <maml:para>This command sets the super user group for the organization to SuperUserGroup@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045240</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AipServiceSuperUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceSuperUserGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Set-AipServiceTemplateProperty</command:name> <command:verb>Set</command:verb> <command:noun>AipServiceTemplateProperty</command:noun> <maml:description> <maml:para>Updates a property or properties of a protection template for Azure Information Protection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AipServiceTemplateProperty cmdlet updates a property or properties of a protection template for Azure Information Protection.</maml:para> <maml:para>You can update most of these properties in the Azure portal.</maml:para> <maml:para>When you use this cmdlet, the template is identified by its GUID, which must refer to an existing protection template. You cannot use this cmdlet to update the default templates.</maml:para> <maml:para>You can use the Get-AipServiceTemplate cmdlet to get the template ID.</maml:para> <maml:para>Important: When you update properties of a protection template, the existing settings for those properties will be overwritten (not supplemented) without warning, so be sure to specify all the settings that you need for the properties that you are updating.</maml:para> <maml:para>As a best practice, back up the existing template before you run this cmdlet, by using the Export-AipServiceTemplate cmdlet. Then, if you need to revert to the original configuration, you can use the Import-AipServiceTemplate cmdlet to restore the template.</maml:para> <maml:para>For more information about protection templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection (https://docs.microsoft.com/information-protection/deploy-use/configure-policy-templates).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AipServiceTemplateProperty</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires. </maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template.</maml:para> <maml:para>The acceptable values for this parameter are: - Never . Indicates that content is available indefinitely. - OnDate . Indicates that content expires at a certain fixed date. - AfterDays .Indicates that content will be available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AfterDays</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organizacion"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in client applications that do not support departmental templates. For this scenario, decide whether all users can see departmental templates from the list of available templates, or no users can see departmental templates in the list.</maml:para> <maml:para>Departmental templates can be created by using the ScopedIdentities parameter, or by creating protection settings in a scoped policy for Azure Information Protection. Department templates might also have been created by using the Azure classic portal (now retired).</maml:para> <maml:para>- If set to True and the template is a departmental template, all users will see the template and therefore be able to select it, regardless of whether the users are members of the template's scope or not.</maml:para> <maml:para>- If set to False, no users see and therefore cannot select the template, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on client applications that natively support departmental templates. This setting also has no effect for Outlook on the web that uses Exchange Online rather than Exchange on-premises and for this scenario, departmental templates are never displayed to users.</maml:para> <maml:para>Note that this setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to see and therefore select the template itself.</maml:para> <maml:para>If you have a client application that does not natively support departmental templates, such as Office 2010, you can use a custom script other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template. The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1.</maml:para> <maml:para>To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template. Valid values are: Published or Archived .</maml:para> <maml:para>- Archived templates are available to consume content previously protected but are not visible to users.</maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Archived</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationDate</maml:name> <maml:Description> <maml:para>Specifies the date on which content protected with the template expires. </maml:para> <maml:para>Use this parameter only if ContentExpirationOption is set to OnDate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentExpirationOption</maml:name> <maml:Description> <maml:para>Specifies the type of content expiration for content protected with the template.</maml:para> <maml:para>The acceptable values for this parameter are: - Never . Indicates that content is available indefinitely. - OnDate . Indicates that content expires at a certain fixed date. - AfterDays .Indicates that content will be available for the indicated number of days after it is protected.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContentExpirationType</command:parameterValue> <dev:type> <maml:name>ContentExpirationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContentValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the number of days from the first day of protection after which content protected with the template expires.</maml:para> <maml:para>Use this parameter only if the ContentExpirationOption parameter is set to AfterDays.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descriptions</maml:name> <maml:Description> <maml:para>Specifies a list of descriptions for the template.</maml:para> <maml:para>Create names and descriptions for multiple locale IDs using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$descriptions = @{}</maml:para> <maml:para>$descriptions[1033] = "This content is confidential and should not be shared externally"</maml:para> <maml:para>$descriptions[1034] = "Este contenido es confidencial y no debe ser compartido fuera de la organizacion"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableInLegacyApps</maml:name> <maml:Description> <maml:para>Determines the behavior of a departmental template in client applications that do not support departmental templates. For this scenario, decide whether all users can see departmental templates from the list of available templates, or no users can see departmental templates in the list.</maml:para> <maml:para>Departmental templates can be created by using the ScopedIdentities parameter, or by creating protection settings in a scoped policy for Azure Information Protection. Department templates might also have been created by using the Azure classic portal (now retired).</maml:para> <maml:para>- If set to True and the template is a departmental template, all users will see the template and therefore be able to select it, regardless of whether the users are members of the template's scope or not.</maml:para> <maml:para>- If set to False, no users see and therefore cannot select the template, even if the users are members of the template's target scope.</maml:para> <maml:para>This setting has no effect on templates that are not departmental templates and also has no effect on client applications that natively support departmental templates. This setting also has no effect for Outlook on the web that uses Exchange Online rather than Exchange on-premises and for this scenario, departmental templates are never displayed to users.</maml:para> <maml:para>Note that this setting does not affect whether a user can access content that is protected by a departmental template; it only affects the ability for a user to see and therefore select the template itself.</maml:para> <maml:para>If you have a client application that does not natively support departmental templates, such as Office 2010, you can use a custom script other tools to deploy these templates to the local RMS client folder. Then, these applications will correctly display the departmental templates:</maml:para> <maml:para>- For Office 2010, the client folder is %localappdata%\Microsoft\DRM\Templates.</maml:para> <maml:para>- From a client computer that has downloaded all the templates, you can copy and then paste the template files to other computers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LicenseValidityDuration</maml:name> <maml:Description> <maml:para>Specifies the validity period of use licenses for content that is protected with this template. The value is specified as the number of days that content is available offline after a use license is acquired (0-9999). During this period users can re-open content they previously accessed without requiring an Internet network connection.</maml:para> <maml:para>Reducing this value gives more control to document owners by helping ensure that content that has been revoked or for which the policy has changed cannot be accessed for too long after these changes.</maml:para> <maml:para>Increasing this value gives more freedom to users to access the content without requiring an Internet network connection.</maml:para> <maml:para>To specify unlimited access, use -1.</maml:para> <maml:para>To specify that a use license must be obtained each time the protected content is accessed and that content is available only with an Internet connection, specify 0.</maml:para> <maml:para>Each organization has a maximum use license validity time, which is 30 days by default and can be configured by using the Set-AipServiceMaxUseLicenseValidityTime. The value that you specify for the LicenseValidityDuration parameter must be lower than that value.</maml:para> <maml:para>When there are different values for the use license validity time, for example, one value for the tenant and one for the template, Azure Information Protection uses the most restrictive value.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Names</maml:name> <maml:Description> <maml:para>Specifies a list of names for the template.</maml:para> <maml:para>Do not include any of the following characters in the name because not all services and applications that use Azure Information Protection can support these characters: `< > % & / ? ; + \ : #`</maml:para> <maml:para>Create names and descriptions for multiple locale IDs by using the hash-table syntax in Windows PowerShell. There must be at least one name/description pair. The locale IDs for names and descriptions must match each other.</maml:para> <maml:para>$names = @{}</maml:para> <maml:para>$names[1033] = "Confidential content"</maml:para> <maml:para>$names[1034] = "Contenido confidencial"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RightsDefinitions</maml:name> <maml:Description> <maml:para>Specifies a list of rights definition objects that are specified by using the New-AipServiceRightsDefinition cmdlet.</maml:para> <maml:para>These rights definition objects express the rights to grant individual users or groups to content that is protected by applying the template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScopedIdentities</maml:name> <maml:Description> <maml:para>Lists the users by email address (account or group) that can see and therefore select departmental templates from applications.</maml:para> <maml:para>For the specified users to see the templates, the application must support departmental templates or the EnableInLegacyApps parameter must be set to True.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Specifies the status of the template. Valid values are: Published or Archived .</maml:para> <maml:para>- Archived templates are available to consume content previously protected but are not visible to users.</maml:para> <maml:para>- Published templates are distributed to users and made available to protect content.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemplateStatus</command:parameterValue> <dev:type> <maml:name>TemplateStatus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Specifies the GUID of a protection template.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Update a template's status ------------</maml:title> <dev:code>PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6428 -Status Published</dev:code> <dev:remarks> <maml:para>This command sets a template status to Published.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Specify users and rights for a protection template </maml:title> <dev:code>PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT" PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW" PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6522 -RightsDefinitions ($r1, $r2)</dev:code> <dev:remarks> <maml:para>This example updates the existing protection template New Launch - Confidential Content for new users and rights. Whereas the existing template granted View and Export rights to the marketing department (which should not change), the engineering department must now also have View rights.</maml:para> <maml:para>Because specifying the RightsDefinitions parameter overwrites the existing settings, the first rights definition object keeps the existing settings for marketing, and another rights definition object creates the new engineering department rights.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 3: Add new users and rights to a protection template -</maml:title> <dev:code>PS C:\> $templateid = "7b1db17a-cb1a-41cf-bad7-b452f9d384c1" PS C:\> [array]$r = New-AipServiceRightsDefinition -EmailAddress pattiful@contoso.com -Rights "DOCEDIT", "EXTRACT" PS C:\> $r += New-AipServiceRightsDefinition -EmailAddress evannar@vanarsdelltd.com -Rights "VIEW" PS C:\> $CurrentRightsDefinitions = [array]((get-AipServiceTemplate -TemplateId $templateid).RightsDefinitions) PS C:\> $ResultingRightsDefinitions = $CurrentRightsDefinitions + $r PS C:\> Set-AipServiceTemplateProperty -TemplateId $templateid -RightsDefinition $ResultingRightsDefinitions</dev:code> <dev:remarks> <maml:para>This set of command adds two new users and their different rights to an existing template, without overwriting the existing users and rights already defined in the template.</maml:para> <maml:para>The new users and their rights are pattiful.contoso.com (a user within the organization) who is granted DOCEDIT and EXTRACT rights; and evannar@vanarsdelltd.com (a user from another organization) who is granted VIEW rights. These users and their rights are added to rights definition objects using an array, which is then added to the existing rights definitions for the template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045424</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceTemplateProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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>Use-AipServiceKeyVaultKey</command:name> <command:verb>Use</command:verb> <command:noun>AipServiceKeyVaultKey</command:noun> <maml:description> <maml:para>Tells Azure Information Protection to use a customer-managed tenant key in Azure Key Vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Use-AipServiceKeyVaultKey cmdlet tells Azure Information Protection to use a customer-managed key (BYOK) in Azure Key Vault.</maml:para> <maml:para>You must use PowerShell to configure your tenant key; you cannot do this configuration by using a management portal.</maml:para> <maml:para>You can run this cmdlet before or after the protection service (Azure Rights Management) is activated. </maml:para> <maml:para>Before you run this cmdlet, make sure that the Azure Rights Management service principal has been granted permissions to the key vault that contains the key you want to use for Azure Information Protection. These permissions are granted by running the Azure Key Vault cmdlet, Set-AzKeyVaultAccessPolicy.</maml:para> <maml:para>For security reasons, the Use-AipServiceKeyVaultKey cmdlet does not let you set or change the access control for the key in Azure Key Vault. After that access is granted by running Set-AzKeyVaultAccessPolicy, run Use-AipServiceKeyVaultKey to tell Azure Information Protection to use the key and version that you specify with the KeyVaultKeyUrl parameter.</maml:para> <maml:para>Note: If you run this cmdlet before the permissions are granted to the key vault, you will see an error that displays The Rights Management service failed to add the key . To see more detailed information, run the command again, with - Verbose . If the permissions are not granted, you see VERBOSE: Failure to access Azure KeyVault .</maml:para> <maml:para>When your command successfully runs, the key is added as an archived customer-managed tenant key for Azure Information Protection for your organization. To make it the active tenant key for Azure Information Protection, you must then run the Set-AipServiceKeyProperties cmdlet.</maml:para> <maml:para>Use Azure Key Vault to centrally manage and monitor use of the key that you specified. All calls to your tenant key will be made to the key vault that your organization owns. You can confirm which key you are using in Key Vault by using the Get-AipServiceKeys cmdlet.</maml:para> <maml:para>For more information about the types of tenant keys that Azure Information Protection supports, see Planning and implementing your Azure Information Protection tenant key (https://docs.microsoft.com/information-protection/plan-design/plan-implement-tenant-key).</maml:para> <maml:para>For more information about Azure Key Vault, see What is Azure Key Vault (https://docs.microsoft.com/azure/key-vault/key-vault-whatis).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-AipServiceKeyVaultKey</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab. </maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</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="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key and version in Azure Key Vault that you want to use for your tenant key.</maml:para> <maml:para>This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</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="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Specifies the friendly name of a trusted publishing domain (TPD) and the SLC key that you imported from AD RMS. If users run Office 2016 or Office 2013, specify the same Friendly name value that is set for the AD RMS cluster properties on the Server Certificate tab. </maml:para> <maml:para>This parameter is optional. If you don't use it, the key identifier is used instead.</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="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyVaultKeyUrl</maml:name> <maml:Description> <maml:para>Specifies the URL of the key and version in Azure Key Vault that you want to use for your tenant key.</maml:para> <maml:para>This key will be used by Azure Information Protection as the root key for all cryptographic operations for your tenant.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <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:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Configure Azure Information Protection to use a customer-managed key in Azure Key Vault</maml:title> <dev:code>PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"</dev:code> <dev:remarks> <maml:para>This command tells Azure Information Protection to use the key named contoso-aipservice-key, version aaaabbbbcccc111122223333, in the key vault named contoso.</maml:para> <maml:para>This key and version in Azure Key Vault then becomes the customer-managed tenant key for Azure Information Protection.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://go.microsoft.com/fwlink/?linkid=2045248</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AipServiceKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AipServiceKeyProperties</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |