{"id":1481,"date":"2014-10-28T10:52:00","date_gmt":"2014-10-28T10:52:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2014\/10\/28\/manage-the-powershell-dsc-extension-in-the-azure-preview-portal\/"},"modified":"2024-02-22T08:24:40","modified_gmt":"2024-02-22T16:24:40","slug":"manage-the-powershell-dsc-extension-in-the-azure-preview-portal","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/manage-the-powershell-dsc-extension-in-the-azure-preview-portal\/","title":{"rendered":"Manage the PowerShell DSC Extension in the Azure Preview Portal"},"content":{"rendered":"

UPDATE 11\/21\/2014: For information on OS support, and other features, please refer to our release history<\/a><\/strong>. <\/strong><\/p>\n

If you haven\u2019t yet started using the Azure Preview Portal<\/a> and are a fan of PowerShell DSC and the Azure PowerShell DSC Extension (announced in August here<\/a>), now just might be the time to start. We are pleased to announce that you can now manage the extension using the Preview Portal! Before today, you could use the Preview Portal to get information about the PowerShell DSC Extension (version, status, and status text \u2013 example below), but you couldn\u2019t add the extension to an existing virtual machine or update the configuration if the extension was already present.<\/p>\n

 <\/p>\n

\"Extension\"<\/a>\u00a0<\/em><\/p>\n

\n

Preparing for the UI<\/h4>\n

Just like with the original example using Fourth Coffee, we need to have a few things ready in order to use the new UI, specifically the ZIP file (containing the Configuration and custom DSC Resources). For our example today, we\u2019ve trimmed down the DSC Configuration for Fourth Coffee and made a slight change (file saved as C:\\examples\\FourthCoffee.ps1):<\/p>\n

 <\/p>\n

\n\n\n\n
\n
001\n002\n003\n004\n005\n006\n007\n008\n009\n010\n011\n012\n013\n014\n015\n016\n017\n018\n019\n020\n021\n022\n023\n024\n025\n026\n027\n028\n029\n030\n031\n032\n033\n034\n035\n036\n037\n038\n039\n040\n041\n042\n043\n044\n045\n046\n047\n048\n049\n050<\/div>\n<\/td>\n
\n
\n

Configuration<\/span>\u00a0<\/span>WebSite<\/span>\n{<\/span>\n\u00a0\u00a0\u00a0 <\/span>Import-DscResource<\/span>\u00a0<\/span>-Module<\/span>\u00a0<\/span>xWebAdministration<\/span>\u00a0\u00a0\u00a0 <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span># Install the IIS role <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>WindowsFeature<\/span>\u00a0<\/span>IIS<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Ensure<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Present’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Name<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Web-Server’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span>\u00a0<\/span>\n\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span># Install the ASP .NET 4.5 role <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>WindowsFeature<\/span>\u00a0<\/span>AspNet45<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Ensure<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Present’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Name<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Web-Asp-Net45’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span>\u00a0<\/span>\n\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span># Stop the default website <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>xWebsite<\/span>\u00a0<\/span>DefaultSite<\/span>\u00a0 <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Ensure<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Present’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Name<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Default Web Site’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>State<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Stopped’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>PhysicalPath<\/span>\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘C:\\inetpub\\wwwroot’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>DependsOn<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘[WindowsFeature]IIS’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span>\u00a0<\/span>\n\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span># Copy the website content <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>File<\/span>\u00a0<\/span>WebContent<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Ensure<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Present’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>SourcePath<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘C:\\Program Files\\WindowsPowerShell\\Modules\\BakeryWebsite’<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>DestinationPath<\/span>\u00a0<\/span>=<\/span>\u00a0<\/span>‘C:\\inetpub\\FourthCoffee’<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Recurse<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>$true<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Type<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Directory’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>DependsOn<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘[WindowsFeature]AspNet45’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span>\u00a0 <\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span># Create a new website <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>xWebsite<\/span>\u00a0<\/span>BakeryWebSite<\/span>\u00a0 <\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Ensure<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Present’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>Name<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘FourthCoffee’<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>State<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘Started’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>PhysicalPath<\/span>\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘C:\\inetpub\\FourthCoffee’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>DependsOn<\/span>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>=<\/span>\u00a0<\/span>‘[File]WebContent’<\/span>\u00a0<\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span>\n}<\/span><\/p>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

You\u2019ll note that we are using the xWebAdministration<\/strong> DSC Resource again. If you haven\u2019t downloaded it and the rest of most current Wave of the DSC Resource Kit, grab the \u2018All Modules\u2019 package here<\/a>.<\/p>\n

With our Configuration file ready, we\u2019ll use PowerShell to prepare the ZIP file. Note that we are using the same cmdlet as before (Publish-AzureVMDscConfiguration<\/strong>), but with a different switch (run from C:\\examples; I split the command in two lines; note the backtick character at the end of the first line):<\/p>\n

PS> Publish-AzureVMDscConfiguration<\/span> .\\FourthCoffee.ps1 `                                                                \r\n>>> -ConfigurationArchivePath<\/span> .\\WebsitePackage1.zip<\/pre>\n
This doesn\u2019t actually upload anything to your Storage Account, it just prepares the ZIP file with the specified Configuration. Additionally, it parses the Configuration for custom DSC Resources and as long as they are present, copies them from your Modules folder into the newly created ZIP.<\/p>\n
\"Created<\/a><\/p>\n
For our example, we are going to manually copy the required web content (available at the bottom of this post) into the ZIP file. You\u2019ll notice in the new FourthCoffe.ps1 Configuration that we declared [File]WebContent<\/em> as getting the files from \u2018C:\\Program Files\\WindowsPowerShell\\Modules\\BakeryWebsite<\/em>\u2019, so we\u2019ll put it at the same root of the ZIP as the \u2018xWebAdministration<\/em>\u2019 folder is. Note that there are of course other ways with PowerShell DSC to get content, this is just for this example (using the Azure Files Preview<\/a> is my new favorite way).<\/p>\n
\"Updated<\/a><\/p>\n
Using the UI<\/h4>\n
Now that our Configuration ZIP (with content) is ready, it\u2019s time to look at the new UI and see what\u2019s possible. In the Azure Preview Portal, browse to your Virtual Machine and in the Configuration space, click on the Extensions box (just like if you were going to go look at the status of the extensions). Now, in the Extensions pane, click the \u2018Add\u2019 button and note that our friend \u2018PowerShell DSC\u2019 is now present!<\/p>\n
\"Add<\/a><\/p>\n
Just like all of the other existing Azure Extensions, when we click on the PowerShell DSC Extension, we get some descriptive information, a Publisher, and a link to resources:<\/p>\n
\"Extension<\/a><\/p>\n
Clicking on the \u2018Create\u2019 button gives the window to input the needed settings. In the event you already have a DSC Extension installed on a VM, you\u2019ll get the second window with the warning:<\/p>\n
\"Extension<\/a> \"Extension<\/a><\/p>\n
For \u2018Configuration Modules or Script\u2019, use the folder and browse to the WebsitePackage.zip that we previously created and added content to. Since we didn\u2019t use any Configuration Data in this example, we\u2019ll skip the \u2018ConfigurationData PSD1 File\u2019. That option allows for the specifying of a Configuration Data file as the name implies and is the equivalent of using \u2013ConfigurationDataPath<\/em> with the Set-AzureVMDscExtension<\/strong> cmdlet. For \u2018Module-qualified Name of Configuration\u2019, use the name of the DSC Configuration file included in the ZIP along with the name of the Configuration in this format (note that the \u2018Configuration File\u2019 may contain more than one DSC configuration; this format ensures the Azure Extension picks up the correct one):<\/p>\n
<ConfigurationFile>.ps1\\<ConfigurationName><\/p>\n
For our example, it will look like this when all put together:<\/p>\n
\"Extension<\/a><\/p>\n
We didn\u2019t have any arguments to pass to the Configuration in this example either, but the \u2018Configuration Arguments\u2019 would be where you placed \u2013ConfigurationArgument<\/em> details. Instead of using a hashtable like in the PowerShell cmdlets, use the format \u2018name1=value1,name2=value\u2019.<\/p>\n
When you click the \u2018Create\u2019 button, the Add Extension pane will disappear and close. You can see that the work is being done and the status by using the Notifications icon on the left bar:<\/p>\n
\"Notifications<\/a><\/p>\n
And when completed:<\/p>\n
\"Notifications<\/a><\/p>\n
Browsing back into our Virtual Machines Configuration and Extensions, we can see that the PowerShell DSC Extension is being installed:<\/p>\n
\"Extension<\/a><\/p>\n
Here\u2019s a rapid set of screen grabs as it progresses and finishes (took about 5 minutes on my VM):<\/p>\n
\"Extension<\/a><\/p>\n
\"Extension<\/a><\/p>\n
\"Extension<\/a><\/p>\n
\"Extension<\/a><\/p>\n
Success! Now, the only thing we have to do is check to see if our content was put in place and the website is working. You can use the Azure Portal to configure an endpoint for this Virtual Machine, but I did it the quick way with PowerShell (note that I split the command in 3 lines):<\/p>\n
PS> Get-AzureVM<\/span> -Name<\/span> sample -ServiceName<\/span> sample-i5oc0t5i |                                                          \r\n>>> Add-AzureEndpoint<\/span> -Name<\/span> HTTP -Protocol<\/span> TCP -LocalPort<\/span> 80<\/span> -PublicPort<\/span> 80<\/span> |                                           \r\n>>> Update-AzureVM<\/span>                                                                                                      \r\n>>>                                                                                                                    \r\n<\/pre>\n
Then I took my favorite browser and went to see if it worked and see that everything on my new VM is exactly as I wanted it. All done!<\/p>\n
\"Website<\/a><\/p>\n
Additional Resources<\/h4>\n
Here are just a few other PowerShell DSC related resources:<\/p>\n
\u00b7 Secure Credentials in the Azure Powershell DSC Extension<\/a><\/p>\n
\u00b7 Troubleshooting the DSC Extension for Azure<\/a><\/p>\n
\u00b7 DSC Resource Kit (All Modules)<\/a><\/p>\n
Happy configuring!<\/p>\n
David Coulter – Microsoft, Senior Consultant<\/p>\n","protected":false},"excerpt":{"rendered":"
UPDATE 11\/21\/2014: For information on OS support, and other features, please refer to our release history. If you haven\u2019t yet started using the Azure Preview Portal and are a fan of PowerShell DSC and the Azure PowerShell DSC Extension (announced in August here), now just might be the time to start. We are pleased to […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1481","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell"],"acf":[],"blog_post_summary":"
UPDATE 11\/21\/2014: For information on OS support, and other features, please refer to our release history. If you haven\u2019t yet started using the Azure Preview Portal and are a fan of PowerShell DSC and the Azure PowerShell DSC Extension (announced in August here), now just might be the time to start. We are pleased to […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1481","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=1481"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1481\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=1481"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=1481"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=1481"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}