Edit

Share via

Get-AzWebApp

  • Reference
Module:
Az.Websites

Gets Azure Web Apps in the specified resource group.

Syntax

Get-AzWebApp
   [[-ResourceGroupName] <String>]
   [[-Name] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzWebApp
   [-AppServicePlan] <PSAppServicePlan>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzWebApp
   [-Location] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzWebApp cmdlet gets information about an Azure Web App.

Examples

Example 1: Get a Web App from a resource group

Get-AzWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite"

This command gets the Web App named ContosoSite that belongs to the resource group Default-Web-WestUS.

Parameters

-AppServicePlan

App Service Plan object

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Location

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

-Name

WebApp Name

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

-ResourceGroupName

Resource Group Name

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

Inputs

String

Outputs

PSSite