en-US/SMBBlueprint-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 |
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-SMBAzureDeployment</command:name> <command:verb>New</command:verb> <command:noun>SMBAzureDeployment</command:noun> <maml:description><maml:para>This command serves as a public interface for the Azure part of the SMB solution. It uses a set of given deployment parameters to start and monitor the ARM-based deployment in Azure. </maml:para> </maml:description> </command:details> <maml:description><maml:para>This command can be used to deploy the Small & Medium Business ARM template towards a managed CSP customer. Based on given parameters, the following steps are executed: </maml:para> <maml:para>1. Connect to the target tenant's subscription 2. Verify that the naming convention is available foruse with the public DNS label and Azure resource group 3. The resource group is created based on a prefix and the customer-name 4. Initiates a new ARM-based deployment with a generated parameter-set to provision the chosen resources 5. While the deployment is occuring, the status is polled every 10 seconds and updated in the job-variable/progress 6. When the deployment is done, all connection and other deployment information is returned </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-SMBAzureDeployment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AdditionalSQLInstanceSize</maml:name> <maml:Description><maml:para>Specifies the size of the Azure SQL instance to deploy. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">small</command:parameterValue> </command:parameterValueGroup> <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>AdditionalVMSize</maml:name> <maml:Description><maml:para>Specifies the size of the additional Azure VM to deploy. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">small</command:parameterValue> <command:parameterValue required="false" variableLength="false">medium</command:parameterValue> </command:parameterValueGroup> <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>AsJob</maml:name> <maml:Description><maml:para>If you want to run the deployment as a background job, this switch can be specified. A job-variable will be returned which can be monitored for deployment progress. </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>Backup</maml:name> <maml:Description><maml:para>Specifies the size of the backup vault to deploy. 'None' can be used to disable the deployment of this resource. If the selected Azure location does not support the backup resource, it will not be deployed regardless of this setting. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">standard</command:parameterValue> </command:parameterValueGroup> <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>Credential</maml:name> <maml:Description><maml:para>The CSP Administrator credentials to use. If this parameter is omitted, you wil be prompted to enter credentials. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CustomerName</maml:name> <maml:Description><maml:para>The name of the customer. This parameter is used to generate the resource group and public DNS names. Non-alphanumeric characters are stripped automatically. If the resulting resource-group or DNS label already exists, an error is generated and the deployment is aborted. </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>CustomerSize</maml:name> <maml:Description><maml:para>The sizing of the customer. This determines the amount of subnets and the size of the essentials VM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">small</command:parameterValue> <command:parameterValue required="false" variableLength="false">medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">large</command:parameterValue> </command:parameterValueGroup> <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>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>ResourceGroupPrefix</maml:name> <maml:Description><maml:para>The naming prefix to use for the Azure resource group to be created. </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>SubscriptionId</maml:name> <maml:Description><maml:para>The GUID of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionName 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>SubscriptionName</maml:name> <maml:Description><maml:para>The name of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionId 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>SysAdminPassword</maml:name> <maml:Description><maml:para>The password to use for the sysadmin account. The password must adhere to the Azure IaaS password requirements. If this parameter is omitted, a random password is used. The password can be consulted in the GUI and return value of this function itself. </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>TenantDomain</maml:name> <maml:Description><maml:para>The name of the Tenant Domain as it is displayed in the CSP portal (not to be confused with the tenant's own default domain). This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantId 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>VPN</maml:name> <maml:Description><maml:para>Specifies whether to deploy a basic VPN gateway or not. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">basic</command:parameterValue> </command:parameterValueGroup> <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>FallbackLocation</maml:name> <maml:Description><maml:para>The location to use for the monitoring- and automation services in case the primary region does not support them. The supported fallback locations are: * westeurope </maml:para> <maml:para>* southeastasia </maml:para> <maml:para>* australiasoutheast </maml:para> <maml:para> </maml:para> <maml:para>When this parameter is omitted and the primary region is not supported, you will be prompted to choose one of the locations, or cancel the deployment. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">westeurope</command:parameterValue> <command:parameterValue required="false" variableLength="false">southeastasia</command:parameterValue> <command:parameterValue required="false" variableLength="false">australiasoutheast</command:parameterValue> </command:parameterValueGroup> <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>Location</maml:name> <maml:Description><maml:para>The Azure location where the solution should be deployed. Some locations impose limits in regards to the backup, automation and monitoring capabilities. Check the 'Backup' and 'FallbackLocation' parameters for more information. </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>Management</maml:name> <maml:Description><maml:para>Controls whether the monitoring and automation resources are deployed. In the current version, this option is not usable and the resources are always deployed. </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>free</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OS</maml:name> <maml:Description><maml:para>Determines the used operating system for the VM deployments. Currently '2012R2' and '2016' are the only supported parameters. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">'2012R2'</command:parameterValue> <command:parameterValue required="false" variableLength="false">'2016'</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>'2012R2'</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-SMBAzureDeployment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AdditionalSQLInstanceSize</maml:name> <maml:Description><maml:para>Specifies the size of the Azure SQL instance to deploy. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">small</command:parameterValue> </command:parameterValueGroup> <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>AdditionalVMSize</maml:name> <maml:Description><maml:para>Specifies the size of the additional Azure VM to deploy. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">small</command:parameterValue> <command:parameterValue required="false" variableLength="false">medium</command:parameterValue> </command:parameterValueGroup> <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>AsJob</maml:name> <maml:Description><maml:para>If you want to run the deployment as a background job, this switch can be specified. A job-variable will be returned which can be monitored for deployment progress. </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>Backup</maml:name> <maml:Description><maml:para>Specifies the size of the backup vault to deploy. 'None' can be used to disable the deployment of this resource. If the selected Azure location does not support the backup resource, it will not be deployed regardless of this setting. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">standard</command:parameterValue> </command:parameterValueGroup> <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>Credential</maml:name> <maml:Description><maml:para>The CSP Administrator credentials to use. If this parameter is omitted, you wil be prompted to enter credentials. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CustomerName</maml:name> <maml:Description><maml:para>The name of the customer. This parameter is used to generate the resource group and public DNS names. Non-alphanumeric characters are stripped automatically. If the resulting resource-group or DNS label already exists, an error is generated and the deployment is aborted. </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>CustomerSize</maml:name> <maml:Description><maml:para>The sizing of the customer. This determines the amount of subnets and the size of the essentials VM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">small</command:parameterValue> <command:parameterValue required="false" variableLength="false">medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">large</command:parameterValue> </command:parameterValueGroup> <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>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>ResourceGroupPrefix</maml:name> <maml:Description><maml:para>The naming prefix to use for the Azure resource group to be created. </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>SubscriptionId</maml:name> <maml:Description><maml:para>The GUID of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionName 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>SubscriptionName</maml:name> <maml:Description><maml:para>The name of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionId 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>SysAdminPassword</maml:name> <maml:Description><maml:para>The password to use for the sysadmin account. The password must adhere to the Azure IaaS password requirements. If this parameter is omitted, a random password is used. The password can be consulted in the GUI and return value of this function itself. </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>TenantId</maml:name> <maml:Description><maml:para>The id of the Tenant. This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantDomain 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>VPN</maml:name> <maml:Description><maml:para>Specifies whether to deploy a basic VPN gateway or not. 'None' can be used to disable the deployment of this resource. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">none</command:parameterValue> <command:parameterValue required="false" variableLength="false">basic</command:parameterValue> </command:parameterValueGroup> <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>FallbackLocation</maml:name> <maml:Description><maml:para>The location to use for the monitoring- and automation services in case the primary region does not support them. The supported fallback locations are: * westeurope </maml:para> <maml:para>* southeastasia </maml:para> <maml:para>* australiasoutheast </maml:para> <maml:para> </maml:para> <maml:para>When this parameter is omitted and the primary region is not supported, you will be prompted to choose one of the locations, or cancel the deployment. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">westeurope</command:parameterValue> <command:parameterValue required="false" variableLength="false">southeastasia</command:parameterValue> <command:parameterValue required="false" variableLength="false">australiasoutheast</command:parameterValue> </command:parameterValueGroup> <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>Location</maml:name> <maml:Description><maml:para>The Azure location where the solution should be deployed. Some locations impose limits in regards to the backup, automation and monitoring capabilities. Check the 'Backup' and 'FallbackLocation' parameters for more information. </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>Management</maml:name> <maml:Description><maml:para>Controls whether the monitoring and automation resources are deployed. In the current version, this option is not usable and the resources are always deployed. </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>free</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OS</maml:name> <maml:Description><maml:para>Determines the used operating system for the VM deployments. Currently '2012R2' and '2016' are the only supported parameters. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">'2012R2'</command:parameterValue> <command:parameterValue required="false" variableLength="false">'2016'</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>'2012R2'</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>AdditionalSQLInstanceSize</maml:name> <maml:Description><maml:para>Specifies the size of the Azure SQL instance to deploy. 'None' can be used to disable the deployment of this resource. </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>AdditionalVMSize</maml:name> <maml:Description><maml:para>Specifies the size of the additional Azure VM to deploy. 'None' can be used to disable the deployment of this resource. </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>AsJob</maml:name> <maml:Description><maml:para>If you want to run the deployment as a background job, this switch can be specified. A job-variable will be returned which can be monitored for deployment progress. </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>Backup</maml:name> <maml:Description><maml:para>Specifies the size of the backup vault to deploy. 'None' can be used to disable the deployment of this resource. If the selected Azure location does not support the backup resource, it will not be deployed regardless of this setting. </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>Credential</maml:name> <maml:Description><maml:para>The CSP Administrator credentials to use. If this parameter is omitted, you wil be prompted to enter credentials. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CustomerName</maml:name> <maml:Description><maml:para>The name of the customer. This parameter is used to generate the resource group and public DNS names. Non-alphanumeric characters are stripped automatically. If the resulting resource-group or DNS label already exists, an error is generated and the deployment is aborted. </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>CustomerSize</maml:name> <maml:Description><maml:para>The sizing of the customer. This determines the amount of subnets and the size of the essentials VM. </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>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>ResourceGroupPrefix</maml:name> <maml:Description><maml:para>The naming prefix to use for the Azure resource group to be created. </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>SubscriptionId</maml:name> <maml:Description><maml:para>The GUID of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionName 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>SubscriptionName</maml:name> <maml:Description><maml:para>The name of the tenant subscription to use. If this parameter is omitted, the default subscription will be used. Do not use in conjunction with the SubscriptionId 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>SysAdminPassword</maml:name> <maml:Description><maml:para>The password to use for the sysadmin account. The password must adhere to the Azure IaaS password requirements. If this parameter is omitted, a random password is used. The password can be consulted in the GUI and return value of this function itself. </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>TenantDomain</maml:name> <maml:Description><maml:para>The name of the Tenant Domain as it is displayed in the CSP portal (not to be confused with the tenant's own default domain). This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantId 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>TenantId</maml:name> <maml:Description><maml:para>The id of the Tenant. This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantDomain 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>VPN</maml:name> <maml:Description><maml:para>Specifies whether to deploy a basic VPN gateway or not. 'None' can be used to disable the deployment of this resource. </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>FallbackLocation</maml:name> <maml:Description><maml:para>The location to use for the monitoring- and automation services in case the primary region does not support them. The supported fallback locations are: * westeurope </maml:para> <maml:para>* southeastasia </maml:para> <maml:para>* australiasoutheast </maml:para> <maml:para> </maml:para> <maml:para>When this parameter is omitted and the primary region is not supported, you will be prompted to choose one of the locations, or cancel the deployment. </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>Location</maml:name> <maml:Description><maml:para>The Azure location where the solution should be deployed. Some locations impose limits in regards to the backup, automation and monitoring capabilities. Check the 'Backup' and 'FallbackLocation' parameters for more information. </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>Management</maml:name> <maml:Description><maml:para>Controls whether the monitoring and automation resources are deployed. In the current version, this option is not usable and the resources are always deployed. </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>free</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OS</maml:name> <maml:Description><maml:para>Determines the used operating system for the VM deployments. Currently '2012R2' and '2016' are the only supported parameters. </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>'2012R2'</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>This function returns a job-variable with the folowing contents: * Type (the deployment-type. This will be 'Azure' for deployments started with this function) </maml:para> <maml:para>* Duration (the duration of the deployment) </maml:para> <maml:para>* Status (Provides status-information for the deployment) </maml:para> <maml:para> * Configuration (contains several outputs of the deployment) * Domain (the domain of the solution) * Login (the username of the default admin account) * Password (the password for the default admin account) * ResourceGroup (the name of the Azure resource group used for the deployment) * Connection (the url to the RDWeb endpoint for remote access) * Completed (equals 'TRUE' if the deployment is done) </maml:para> <maml:para>* Error (if an exception occured during the deployment, it will be stored here) </maml:para> <maml:para>* Log (the full location of the logfile for the deployment) </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:\> New-SMBAzureDeployment -AdditionalSQLInstanceSize small -AdditionalVMSize medium -TenantDomain Contoso.com -CustomerName Contoso -CustomerSize small -SysAdminPassword MySecretP@ssword1234 -Backup standard -Credential $MyCredential -SubscriptionId 3812cde5-cb5e-42de-a673-20228eed897f -VPN basic</dev:code> <dev:remarks><maml:para>This example will deploy a small SMB scenario to the Contoso.com CSP tenant with the following resources: * 1 Essentials VM (small size) </maml:para> <maml:para>* 1 Additional VM (medium size) </maml:para> <maml:para>* 1 Additional Azure SQL instance (small size) </maml:para> <maml:para>* 1 basic VPN gateway </maml:para> <maml:para>* Backup of the essential and additional machines </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://inovativ.github.io/SMBblueprint-Docs/</maml:linkText> <maml:uri>https://inovativ.github.io/SMBblueprint-Docs/</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-SMBOfficeDeployment</command:name> <command:verb>New</command:verb> <command:noun>SMBOfficeDeployment</command:noun> <maml:description><maml:para>This command serves as a public interface for the O365 part of the SMB solution. It uses a set of given deployment parameters to start and monitor the user/group-deployment in O365. </maml:para> </maml:description> </command:details> <maml:description><maml:para>This command will use a given CSV file and Tenant Information to orchestrate the provisioning of O365 users and groups. The following steps are executed: 1. Create a local admin account in the O365 subscription of the tenant to bypass some CSP restrictions regarding Groups/Onedrive provisioning 1. Parse the CSV information and alert on licensing issues 2. Create the specified users in the tenant's Azure AD, and assign the appropriate licenses 3. Create the specified Office Groups in Exchange Online (part of O365), using the local admin account 4. Populate user/group owner/membership, using the local admin account 5. Pre-provision all user's Onedrives, using the local admin account in combination with Sharepoint Online 6. Output all provisioning info </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-SMBOfficeDeployment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>The CSP Partner credential to use for the deployment </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CSV</maml:name> <maml:Description><maml:para>The location of the CSV file that contains the O365 inventory. The following information must be present in this file: * First (the first-name of the user) </maml:para> <maml:para>* Last (the last-name of the user) </maml:para> <maml:para>* Title (the user's title or function) </maml:para> <maml:para>* DisplayName (currently not in use) </maml:para> <maml:para>* Department (the user's department) </maml:para> <maml:para>* Office (the user's office location) </maml:para> <maml:para>* Mobile (the user's mobile phone number) </maml:para> <maml:para>* Country (the user's country, expressed as an ISO-code (https://www.iso.org/obp/ui/#search))* Groups (the group to which the user should belong) * If the group is mentioned for the first time, the associated user will be set as owner. Subsequent users that have the same group specified will be a regular member. * The created groups will be private Office Groups * License (the license to assign to the user, expressed as the SKU code, which can be found using get-msolaccountsku -TenantId <ID of your CSP tenant>) * You can get the tenant-id's under your CSP account by connecting to your root Azure AD with 'Connect-MSOLService' and then querying the tenants with 'Get-MSOLPartnerContract -All|select DefaultDomainName,TenantId' </maml:para> <maml:para>> Example CSV: First,Last,Title,DisplayName,Department,Office,Mobile,Country,Groups,License Jan,Van Meirvenne,Consultant,Jan.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup1,O365_BUSINESS_PREMIUM Jin,Van Meirvenne,Consultant,Jin.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM Jon,Van Meirvenne,Consultant,Jon.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM </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>DefaultPassword</maml:name> <maml:Description><maml:para>The initial password to use for the users to provision. The password must adhere to the Azure AD password policy (https://azure.microsoft.com/en-us/documentation/articles/active-directory-passwords-policy/). If this parameter is omitted, a random password is generated. The password can be consulted from the function's job output. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>MailDomain</maml:name> <maml:Description><maml:para>The mail-suffix to use for the provisioned users. This domain must be a validated domain in the tenant. If this parameter is omitted, the default tenant domain is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SyncHash</maml:name> <maml:Description><maml:para>Internal parameter that provides integration with the GUI. Has no functional value and hence should not be used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</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>TenantDomain</maml:name> <maml:Description><maml:para>The name of the Tenant Domain as it is displayed in the CSP portal (not to be confused with the tenant's own default domain). This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantId 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:syntaxItem> <command:syntaxItem><maml:name>New-SMBOfficeDeployment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>The CSP Partner credential to use for the deployment </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CSV</maml:name> <maml:Description><maml:para>The location of the CSV file that contains the O365 inventory. The following information must be present in this file: * First (the first-name of the user) </maml:para> <maml:para>* Last (the last-name of the user) </maml:para> <maml:para>* Title (the user's title or function) </maml:para> <maml:para>* DisplayName (currently not in use) </maml:para> <maml:para>* Department (the user's department) </maml:para> <maml:para>* Office (the user's office location) </maml:para> <maml:para>* Mobile (the user's mobile phone number) </maml:para> <maml:para>* Country (the user's country, expressed as an ISO-code (https://www.iso.org/obp/ui/#search))* Groups (the group to which the user should belong) * If the group is mentioned for the first time, the associated user will be set as owner. Subsequent users that have the same group specified will be a regular member. * The created groups will be private Office Groups * License (the license to assign to the user, expressed as the SKU code, which can be found using get-msolaccountsku -TenantId <ID of your CSP tenant>) * You can get the tenant-id's under your CSP account by connecting to your root Azure AD with 'Connect-MSOLService' and then querying the tenants with 'Get-MSOLPartnerContract -All|select DefaultDomainName,TenantId' </maml:para> <maml:para>> Example CSV: First,Last,Title,DisplayName,Department,Office,Mobile,Country,Groups,License Jan,Van Meirvenne,Consultant,Jan.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup1,O365_BUSINESS_PREMIUM Jin,Van Meirvenne,Consultant,Jin.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM Jon,Van Meirvenne,Consultant,Jon.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM </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>DefaultPassword</maml:name> <maml:Description><maml:para>The initial password to use for the users to provision. The password must adhere to the Azure AD password policy (https://azure.microsoft.com/en-us/documentation/articles/active-directory-passwords-policy/). If this parameter is omitted, a random password is generated. The password can be consulted from the function's job output. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>MailDomain</maml:name> <maml:Description><maml:para>The mail-suffix to use for the provisioned users. This domain must be a validated domain in the tenant. If this parameter is omitted, the default tenant domain is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SyncHash</maml:name> <maml:Description><maml:para>Internal parameter that provides integration with the GUI. Has no functional value and hence should not be used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</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>TenantId</maml:name> <maml:Description><maml:para>The id of the Tenant. This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantDomain 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:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>The CSP Partner credential to use for the deployment </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CSV</maml:name> <maml:Description><maml:para>The location of the CSV file that contains the O365 inventory. The following information must be present in this file: * First (the first-name of the user) </maml:para> <maml:para>* Last (the last-name of the user) </maml:para> <maml:para>* Title (the user's title or function) </maml:para> <maml:para>* DisplayName (currently not in use) </maml:para> <maml:para>* Department (the user's department) </maml:para> <maml:para>* Office (the user's office location) </maml:para> <maml:para>* Mobile (the user's mobile phone number) </maml:para> <maml:para>* Country (the user's country, expressed as an ISO-code (https://www.iso.org/obp/ui/#search))* Groups (the group to which the user should belong) * If the group is mentioned for the first time, the associated user will be set as owner. Subsequent users that have the same group specified will be a regular member. * The created groups will be private Office Groups * License (the license to assign to the user, expressed as the SKU code, which can be found using get-msolaccountsku -TenantId <ID of your CSP tenant>) * You can get the tenant-id's under your CSP account by connecting to your root Azure AD with 'Connect-MSOLService' and then querying the tenants with 'Get-MSOLPartnerContract -All|select DefaultDomainName,TenantId' </maml:para> <maml:para>> Example CSV: First,Last,Title,DisplayName,Department,Office,Mobile,Country,Groups,License Jan,Van Meirvenne,Consultant,Jan.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup1,O365_BUSINESS_PREMIUM Jin,Van Meirvenne,Consultant,Jin.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM Jon,Van Meirvenne,Consultant,Jon.VanMeirvenne,ICT,Inovativ,32478707741,BE,TestGroup10,O365_BUSINESS_PREMIUM </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>DefaultPassword</maml:name> <maml:Description><maml:para>The initial password to use for the users to provision. The password must adhere to the Azure AD password policy (https://azure.microsoft.com/en-us/documentation/articles/active-directory-passwords-policy/). If this parameter is omitted, a random password is generated. The password can be consulted from the function's job output. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Log</maml:name> <maml:Description><maml:para>This parameter is for internal use. To prevent a new logfile from being created when running in GUI-mode, the existing log-file to use is passed. </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>MailDomain</maml:name> <maml:Description><maml:para>The mail-suffix to use for the provisioned users. This domain must be a validated domain in the tenant. If this parameter is omitted, the default tenant domain is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SyncHash</maml:name> <maml:Description><maml:para>Internal parameter that provides integration with the GUI. Has no functional value and hence should not be used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</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>TenantDomain</maml:name> <maml:Description><maml:para>The name of the Tenant Domain as it is displayed in the CSP portal (not to be confused with the tenant's own default domain). This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantId 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>TenantId</maml:name> <maml:Description><maml:para>The id of the Tenant. This is used to select the target tenant for the deployment. Do not use in conjunction with the TenantDomain 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: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.Management.Automation.PSObject</maml:name> </dev:type> <maml:description><maml:para>This function returns a job-variable with the folowing contents: * Type (the deployment-type. This will be 'Office' for deployments started with this function) </maml:para> <maml:para>* Duration (the duration of the deployment) </maml:para> <maml:para>* Status (Provides status-information for the deployment) </maml:para> <maml:para> * Configuration (contains several outputs of the deployment) * ProvisionedUsers (a list of all provisioned users including login-information) * ProvisionedGroups (a list of all provisioned office groups) * Completed (equals 'TRUE' if the deployment is done) </maml:para> <maml:para>* Error (if an exception occured during the deployment, it will be stored here) </maml:para> <maml:para>* Log (the full location of the logfile for the deployment) </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:\> New-SMBOfficeDeployment -DefaultPassword MySecretPassword -Credential $MyCredential -MailDomain contoso.com -CSV C:\SMBUsers.csv -TenantId 95e2e584-5e01-4065-bcee-8203d1005a90</dev:code> <dev:remarks><maml:para>This example will use the information specified in the given CSV to provision a set of users and groups in the specified CSP tenant. The suffix '@Contoso.Com' will be used for the UPN of the users. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://inovativ.github.io/SMBblueprint-Docs/</maml:linkText> <maml:uri>https://inovativ.github.io/SMBblueprint-Docs/</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>Start-SMBDeploymentGUI</command:name> <command:verb>Start</command:verb> <command:noun>SMBDeploymentGUI</command:noun> <maml:description><maml:para>Launches a grpahical interface to provide a more guided experience when using the SMB Blueprint solution </maml:para> </maml:description> </command:details> <maml:description><maml:para>This command launches a GUI based on WPF XAML code, external PNG images (bundled with this module) and PS-based code-behind. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Start-SMBDeploymentGUI</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></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:\> Start-SMBDeploymentGUI</dev:code> <dev:remarks><maml:para>Launches the graphical user interface of the SMB solution </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://inovativ.github.io/SMBblueprint-Docs/</maml:linkText> <maml:uri>https://inovativ.github.io/SMBblueprint-Docs/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |