Edit

Share via

Get-AzWebAppSSLBinding

Module:
Az.Websites Module

Gets an Azure Web App certificate SSL binding.

Syntax

S1 

Get-AzWebAppSSLBinding
    [[-Name] <String>]
    [-ResourceGroupName] <String>
    [-WebAppName] <String>
    [[-Slot] <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

S2 

Get-AzWebAppSSLBinding
    [[-Name] <String>]
    [-WebApp] <PSSite>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzWebAppSSLBinding cmdlet gets a Secure Sockets Layer (SSL) binding for an Azure Web App. SSL bindings are used to associate a Web App with an uploaded certificate. Web Apps can be bound to multiple certificates.

Examples

Example 1: Get SSL bindings for a Web App

Get-AzWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp"

This command retrieves the SSL bindings for the Web App ContosoWebApp, which is associated with the resource group ContosoResourceGroup.

Example 2: Use an object reference to get SSL bindings for a Web App

$WebApp = Get-AzWebApp -Name "ContosoWebApp"
Get-AzWebAppSSLBinding -WebApp $WebApp

The commands in this example also get the SSL bindings for the Web App ContosoWebApp; in this case, however, an object reference is used instead of the Web App name and the name of the associated resource group. This object reference is created by the first command in the example, which uses Get-AzWebApp to create an object reference to the Web App named ContosoWebApp. That object reference is stored in a variable named $WebApp. This variable, and the Get-AzWebAppSSLBinding cmdlet, are then used by the second command to get the SSL bindings.

Parameters

-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

-Name

Specifies the name of the SSL binding.

Parameter properties

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

Parameter sets

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

-ResourceGroupName

Specifies the name of the resource group that the certificate is assigned to. You cannot use the ResourceGroupName parameter and the WebApp parameter in the same command.

Parameter properties

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

Parameter sets

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

-Slot

Specifies a Web App deployment slot. To get a deployment slot, use the Get-AzWebAppSlot cmdlet.

Parameter properties

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

Parameter sets

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

-WebApp

Specifies a Web App. To get a Web App, use the Get-AzWebApp cmdlet.

Parameter properties

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

Parameter sets

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

-WebAppName

Specifies the name of the Web App that this cmdlet gets SSL bindings from. You cannot use the WebAppName parameter and the WebApp parameter in the same command.

Parameter properties

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

Parameter sets

S1
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
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

PSSite

Outputs

HostNameSslState