Edit

Share via

Get-AzureRmWebAppPublishingProfile

  • Reference
Module:
AzureRM.Websites

Gets an Azure Web App publishing profile.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmWebAppPublishingProfile
   [[-OutputFile] <String>]
   [[-Format] <String>]
   [-IncludeDisasterRecoveryEndpoints]
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmWebAppPublishingProfile
   [[-OutputFile] <String>]
   [[-Format] <String>]
   [-IncludeDisasterRecoveryEndpoints]
   [-WebApp] <PSSite>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmWebAppPublishingProfile cmdlet gets an Azure Web App publishing profile.

Examples

1:

PS C:\> Get-AzureRmWebAppPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile"

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:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Format

Format

Type:String
Accepted values:WebDeploy, FileZilla3, Ftp
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeDisasterRecoveryEndpoints

Include the disaster recovery endpoints if true

Type:SwitchParameter
Position:None
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

WebApp Name

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OutputFile

Output File

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Resource Group Name

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WebApp

WebApp Object

Type:PSSite
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Site

Parameters: WebApp (ByValue)

Outputs

String