Edit

Share via

Get-AzureRmWebAppSSLBinding

  • Reference
Module:
AzureRM.Websites

Gets an Azure Web App certificate SSL binding.

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-AzureRmWebAppSSLBinding
   [[-Name] <String>]
   [-ResourceGroupName] <String>
   [-WebAppName] <String>
   [[-Slot] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmWebAppSSLBinding
   [[-Name] <String>]
   [-WebApp] <PSSite>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmWebAppSSLBinding 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

PS C:\>Get-AzureRmWebAppSSLBinding -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

PS C:\>$WebApp = Get-AzureRmWebApp -Name "ContosoWebApp"
PS C:\> Get-AzureRmWebAppSSLBinding -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-AzureRmWebApp 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-AzureRmWebAppSSLBinding 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.

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

-Name

Specifies the name of the SSL binding.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Slot

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

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

-WebApp

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

Type:PSSite
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

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

Inputs

Site

Parameters: WebApp (ByValue)

Outputs

HostNameSslState