Get-AzurePublishSettingsFile
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzurePublishSettingsFile
Downloads the .publishsettings file for a Windows Azure subscription.
Parameter Set: Default
Get-AzurePublishSettingsFile [[-Realm] <String> ] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
The Get-AzurePublishSettingsFile cmdlet opens your default browser, signs into your Windows Azure account, and automatically downloads a .publishsettings file that contains information and a certificate for your Windows Azure subscription. This file is used by the Import-AzureSubscription cmdlet and is an XML file with a ".publishsettings" extension.
Security Note: The publishsettings file contains the credentials (unencoded) that are used to administer your Windows Azure subscriptions and services. The security best practice for this file is to store it temporarily outside your source directories (for example in the Libraries\Documents folder), and then delete it after the settings have been imported. A malicious user gaining access to the publishsettings file can edit, create, and delete your Windows Azure services.
-Realm<String>
Specifies the organization ID to use for federated authentication when displaying the Windows Azure Portal.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Example 1
This example opens your default browser, connects to your Windows Azure account, and then automatically downloads the .publishsettings file for your account.
PS C:\> Get-AzurePublishSettingsFile