Edit

Share via


Get-AzWebApp

Gets Azure Web Apps in the specified resource group.

Syntax

S1

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

S2

Get-AzWebApp
    [-AppServicePlan] <PSAppServicePlan>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

S3

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

Parameter properties

Type:PSAppServicePlan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

S2
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

Location

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

S3
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

WebApp Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

S1
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Resource Group Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

S1
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

PSSite