Get-AzWebAppPublishingProfile
Gets an Azure Web App publishing profile.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Get-AzWebAppPublishingProfile
[[-OutputFile] <String>]
[[-Format] <String>]
[-IncludeDisasterRecoveryEndpoints]
[-ResourceGroupName] <String>
[-Name] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzWebAppPublishingProfile
[[-OutputFile] <String>]
[[-Format] <String>]
[-IncludeDisasterRecoveryEndpoints]
[-WebApp] <PSSite>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzWebAppPublishingProfile cmdlet gets an Azure Web App publishing profile.
Examples
Example 1
PS C:\> Get-AzWebAppPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile.publishsettings"
This command gets the publishing profile in Ftp format for Web App ContosoWebApp associated with the resource group Default-Web-WestUS and stores it in the specified output file.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Format
Format
| Type: | String |
| Accepted values: | WebDeploy, FileZilla3, Ftp |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeDisasterRecoveryEndpoints
Include the disaster recovery endpoints if true
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
WebApp Name
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OutputFile
Output File
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WebApp
WebApp Object
| Type: | PSSite |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |